Code cleanup

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

diff --git a/documentation_fr.md b/documentation_fr.md
index 622b05445eb10f32e381fca89ad05096af69e609..2371517c8173dadc583461c2a71b8cc8e49533a9 100644 (file)
--- a/documentation_fr.md
+++ b/documentation_fr.md
@@ -8,26 +8,33 @@ 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
+        sudo apt-get install libav-tools
 
-Si vous utilisez la version compilée de Music Sampler, il n'y a rien d'autre à installer.
+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:
+- Pour utiliser les sources directement, les modules suivants sont requis:
 
 | module      | version minimale | commentaire                      |
 | ----------- | ---------------- | -------------------------------- |
+| Cython      | 0.24             | pour compiler Kivy               |
 | Kivy        | 1.9.1            |                                  |
 | Markdown    | 2.6.6            | pour la documentation uniquement |
 | pydub       | 0.16.4           |                                  |
-| Pygame      | 1.9.2pre         | utilisée par Kivy                |
+| 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:
+
+    pip install music_sampler
+
+Le programme utilise les polices "Symbola" et "Ubuntu" (Regular / Bold), qui doivent être disponibles, et la librairie portaudio:
+
+    sudo apt-get install ttf-ancient-fonts ttf-ubuntu-font-family portaudio
 
 ## Version compilée
 
@@ -36,6 +43,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.
@@ -326,15 +338,15 @@ On utilise ensuite, dans le fichier de configuration, `include: alias1` ou `incl
 
 Sont listés ci-dessous une liste de problèmes rencontrés, avec des solutions proposées. Si vous en découvrez d'autre, contactez l'auteur pour les ajouter à la liste.
 
- * Le programme se lance et s'arrête tout de suite.
+* Le programme se lance et s'arrête tout de suite.
 
 Il s'agit généralement d'une erreur de syntaxe dans le fichier de config. Dans ce cas, le terminal doit afficher quelques détails sur l'erreur en question (au moins la ligne correspondante).
 
- * La musique "grésille" affreusement.
+* La musique "grésille" affreusement.
 
 Il peut s'agir d'un problème de latence (avec certains ordinateurs un peu lents). Essayez de changer la latence (par exemple, 0.1 seconde)
 
-  * Impossible de jouer plus d'une musique à la fois.
+* Impossible de jouer plus d'une musique à la fois.
 
 Le système n'arrive pas à mixer les musiques par lui-même. Vous pouvez essayer de regarder la liste des périphériques de son (`--list-devices`) puis en sélectionner un autre si disponible. Vous pouvez aussi essayer le mixeur intégré à music_sampler, mais les résultats ne sont pas toujours très fluides (ne pas hésiter à jouer avec les paramètres avancés comme latency et blocksize).
 
@@ -354,7 +366,19 @@ Si votre système utilise PulseAudio, il peut s'agir d'un problème de configura
       fallback "sysdefault"
     }
 
-  * Pour d'autres problèmes ou bugs à reporter, voir le [Bug Tracker](https://git.immae.eu/mantisbt/view_all_bug_page.php?project_id=1)
+* La console affiche une erreur :
+
+        Exception in thread Thread-1:
+        Traceback (most recent call last):
+          File "threading.py", line 914, in _bootstrap_inner
+          File "threading.py", line 862, in run
+          File "kivy/input/providers/mtdev.py", line 219, in _thread_run
+          File "kivy/lib/mtdev.py", line 131, in __init__
+        PermissionError: [Errno 13] Permission denied: '/dev/input/event6'
+
+C'est une erreur de permission d'accès à un périphérique, généré par la librairie kivy. Elle peut être ignorée et n'aura pas d'incidence.
+
+* Pour d'autres problèmes ou bugs à reporter, voir le [Bug Tracker](https://git.immae.eu/mantisbt/view_all_bug_page.php?project_id=1&sort=status%2Clast_updated&dir=ASC%2CDESC)
 ## Divers
 
 Les extraits de musiques proposés en exemples proviennent de [Jamendo](https://jamendo.com). Les musiques (complètes) sont disponibles en libre téléchargement pour un usage non commercial :