Use setuptools_scm to determinate project version

[perso/Immae/Projets/Python/MusicSampler.git] / documentation_fr.md

diff --git a/documentation_fr.md b/documentation_fr.md
index 5cdc48d8845b6a62376ae935dc751bc86ac4dfd5..ccfcf9b75d551d4514cce59afc14d5c5c0e89ee0 100644 (file)
--- a/documentation_fr.md
+++ b/documentation_fr.md
@@ -8,12 +8,36 @@ Music Sampler est un lecteur de musique qui permet de pré-programmer des transi
 
 ## Pré-requis et installation
 
-Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` :
+- Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` :
 
-    :::bash
+    ```
     sudo apt-get install libav-tools
+    ```
+
+Si vous utilisez la version compilée de Music Sampler (cf. plus bas pour un lien de téléchargement), il n'y a rien d'autre à installer.
+
+- Pour utiliser les sources directement, les modules suivants sont requis:
+
+| module      | version minimale | commentaire                      |
+| ----------- | ---------------- | -------------------------------- |
+| Kivy        | 1.9.1            |                                  |
+| Markdown    | 2.6.6            | pour la documentation uniquement |
+| pydub       | 0.16.4           |                                  |
+| Pygame      | 1.9.2.dev1       | utilisée par Kivy                |
+| Pygments    | 2.1.3            | pour la documentation uniquement |
+| sounddevice | 0.3.3            |                                  |
+| transitions | 0.4.1            |                                  |
+| PyYAML      | 3.11             |                                  |
+
+Le projet est également disponible via pip:
 
-Si vous utilisez la version compilée de Music Sampler, il n'y a rien d'autre à installer.
+    pip install music_sampler
+
+- Le programme utilise les polices "Symbola" et "Ubuntu" (Regular / Bold), qui doivent être disponibles.
+
+    ```
+    sudo apt-get install ttf-ancient-fonts ttf-ubuntu-font-family
+    ```
 
 ## Version compilée
 
@@ -22,6 +46,11 @@ Une version compilée peut être créée avec pyinstaller:
     :::bash
     pyinstaller music_sampler.spec
 
+## Téléchargements
+
+- Un exemple de configuration ainsi que des musiques associées à l'exemple peuvent être trouvées sur [owncloud](https://outils.immae.eu/owncloud/index.php/s/kSrIe15G1AiZ9YF)
+- Une version précompilée de `music_sampler` peut également être téléchargée [dans le même dossier](https://outils.immae.eu/owncloud/index.php/s/kSrIe15G1AiZ9YF/download?path=%2F&files=music_sampler) (attention, elle n'est pas toujours forcément à jour, lancer le programme avec `-V` pour voir la version compilée)
+
 ## Utilisation
 
 Tout le travail consiste à préparer les transitions dans le fichier de configuration config.yml.