Add config

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

diff --git a/documentation_en.md b/documentation_en.md
index ee95ad38da5af6ab2092bb6920495527295b95d7..2f570e1213e490261095d0e1d0f75948c7eeb29a 100644 (file)
--- a/documentation_en.md
+++ b/documentation_en.md
@@ -48,12 +48,12 @@ To compile Kivy with the SDL2 library, you need some packages:
 cf [Installation
 Kivy](https://kivy.org/docs/installation/installation-linux.html)
 
-## Installation sous Windows
+## Windows installation
 
 Following processed worked to install music sampler in a Windows
 machine:
 
-- [Install python 3.7.\* (take 64bit version!)](https://www.python.org/downloads/windows)
+- [Install python 3.9.\* (take 64bit version!)](https://www.python.org/downloads/windows)
 - In a command shell (`cmd.exe`), run:
 
         pip install music_sampler
@@ -157,6 +157,7 @@ in case of problem with the standard configuration:
     (default 2).
   * `--device DEVICE` : select another sound device.
   * `--list-devices` : list available sound devices.
+  * `--load-all-musics` : load all the music when starting (default True)
   * `-- ARGS` : arguments for Kivy library.
 
 ## Configure keys
@@ -348,6 +349,8 @@ Pauses "music1.mp3" for 10 seconds and reruns it afterward, seeking to 5 seconds
 later.
 
 #### List of all the actions:
+- `comment`: does nothing, but shows a comment in the action windows
+    * `message: "some text"` the message to show
 - `play` : start a music. Music Sampler only runs a music once (if you want to
   have it playing several time concurrently, duplicate it or make symbolic
   link). Parameters:
@@ -436,6 +439,9 @@ actions.
     * `command: my_command` : Gives the command to run.
     * `wait: true/false` (optional, default false) if true, waits for the
       command to finish (this wait is not interruptible by interrupt_wait)
+- `load_music/unload_music` : load/unload a music from memory. Useful
+  with `load_all_musics` option only
+    * `music: "music.mp3" the music to load/unload
 
 ### `aliases` : define aliases