diff options
-rw-r--r-- | build_readme.py | 10 | ||||
-rw-r--r-- | documentation_fr.md | 11 |
2 files changed, 21 insertions, 0 deletions
diff --git a/build_readme.py b/build_readme.py new file mode 100644 index 0000000..36df8a1 --- /dev/null +++ b/build_readme.py | |||
@@ -0,0 +1,10 @@ | |||
1 | import markdown | ||
2 | |||
3 | html = markdown.markdownFromFile( | ||
4 | input="documentation_fr.md", | ||
5 | extensions=['markdown.extensions.codehilite'], | ||
6 | extension_configs={ | ||
7 | 'markdown.extensions.codehilite': { | ||
8 | 'noclasses': True, | ||
9 | } | ||
10 | }) | ||
diff --git a/documentation_fr.md b/documentation_fr.md index ef3896b..c12c666 100644 --- a/documentation_fr.md +++ b/documentation_fr.md | |||
@@ -10,6 +10,7 @@ Music Sampler permet de pré-programmer des transitions musicales, qui peuvent e | |||
10 | 10 | ||
11 | Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` : | 11 | Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` : |
12 | 12 | ||
13 | :::bash | ||
13 | sudo apt-get install libav-tools | 14 | sudo apt-get install libav-tools |
14 | 15 | ||
15 | Si vous utilisez la version compilée de Music Sampler, il n'y a pas d'installation nécessaire. | 16 | Si vous utilisez la version compilée de Music Sampler, il n'y a pas d'installation nécessaire. |
@@ -29,6 +30,7 @@ le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne | |||
29 | 30 | ||
30 | Le fichier contient plusieurs sections : | 31 | Le fichier contient plusieurs sections : |
31 | 32 | ||
33 | :::yaml | ||
32 | aliases: | 34 | aliases: |
33 | ... | 35 | ... |
34 | 36 | ||
@@ -48,11 +50,13 @@ Cette section sert à définir des propriétés globales des musiques. | |||
48 | 50 | ||
49 | #### Exemples | 51 | #### Exemples |
50 | 52 | ||
53 | :::yaml | ||
51 | "music1.mp3": | 54 | "music1.mp3": |
52 | name: My favorite music | 55 | name: My favorite music |
53 | gain: 1.4 | 56 | gain: 1.4 |
54 | La musique "music1.mp3" est désignée par le nom "My favorite music". Elle est chargée à 140% de son volume normal. | 57 | La musique "music1.mp3" est désignée par le nom "My favorite music". Elle est chargée à 140% de son volume normal. |
55 | 58 | ||
59 | :::yaml | ||
56 | "music2.mp3": | 60 | "music2.mp3": |
57 | gain: 0.7 | 61 | gain: 0.7 |
58 | 62 | ||
@@ -68,6 +72,7 @@ Cette section sert à décrire l'affichage à l'écran des touches : couleur et | |||
68 | 72 | ||
69 | #### Exemples | 73 | #### Exemples |
70 | 74 | ||
75 | :::yaml | ||
71 | 'ESC': | 76 | 'ESC': |
72 | description: | 77 | description: |
73 | - | 78 | - |
@@ -88,6 +93,7 @@ Cette section sert à décrire, pour chaque touche, la liste des actions success | |||
88 | 93 | ||
89 | #### Exemples | 94 | #### Exemples |
90 | 95 | ||
96 | :::yaml | ||
91 | 'a': | 97 | 'a': |
92 | - play: | 98 | - play: |
93 | file: "music1.mp3" | 99 | file: "music1.mp3" |
@@ -97,8 +103,10 @@ Cette section sert à décrire, pour chaque touche, la liste des actions success | |||
97 | - stop: | 103 | - stop: |
98 | file: "music1.mp3" | 104 | file: "music1.mp3" |
99 | fade_out 2 | 105 | fade_out 2 |
106 | |||
100 | Lance la musique "music1.mp3" à 70% de son volume max, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes. | 107 | Lance la musique "music1.mp3" à 70% de son volume max, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes. |
101 | 108 | ||
109 | :::yaml | ||
102 | 'b': | 110 | 'b': |
103 | - stop: | 111 | - stop: |
104 | file "music1.mp3" | 112 | file "music1.mp3" |
@@ -110,6 +118,7 @@ Lance la musique "music1.mp3" à 70% de son volume max, puis au bout de 5 second | |||
110 | 118 | ||
111 | Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3" | 119 | Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3" |
112 | 120 | ||
121 | :::yaml | ||
113 | 'c': | 122 | 'c': |
114 | - stop: | 123 | - stop: |
115 | file "music1.mp3" | 124 | file "music1.mp3" |
@@ -125,6 +134,7 @@ Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3" | |||
125 | value: 60 | 134 | value: 60 |
126 | Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fondu, puis attend deux secondes et lance la musique "music2.mp3", au temps d'une minute. | 135 | Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fondu, puis attend deux secondes et lance la musique "music2.mp3", au temps d'une minute. |
127 | 136 | ||
137 | :::yaml | ||
128 | 'd': | 138 | 'd': |
129 | - volume: | 139 | - volume: |
130 | file "music1.mp3" | 140 | file "music1.mp3" |
@@ -140,6 +150,7 @@ Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fond | |||
140 | 150 | ||
141 | Baisse temporairement (pour 2 secondes) le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (joué deux fois). | 151 | Baisse temporairement (pour 2 secondes) le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (joué deux fois). |
142 | 152 | ||
153 | :::yaml | ||
143 | 'e': | 154 | 'e': |
144 | - pause: | 155 | - pause: |
145 | file: "music1.mp3" | 156 | file: "music1.mp3" |