X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=documentation_en.md;h=c616eda8ad724db3c4120d08f6639b87e409cbec;hb=de71c01cd5c6dca3b33201a9effafc6c422fa239;hp=d65e7ad6f4ce95e752f96c55aa4333be277b83d6;hpb=dac64df84b0ed14199f41ac163d12ec20e497213;p=perso%2FImmae%2FProjets%2FPython%2FMusicSampler.git

diff --git a/documentation_en.md b/documentation_en.md
index d65e7ad..c616eda 100644
--- a/documentation_en.md
+++ b/documentation_en.md
@@ -9,6 +9,8 @@ set of actions to run.
 
 ## Dependencies and installation
 
+(See next section for Windows installation)
+
 - You need ffmpeg installed. For that, you can use package `libav-tools` (debian):
 
         sudo apt-get install libav-tools
@@ -46,6 +48,31 @@ 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
+
+Following processed worked to install music sampler in a Windows
+machine:
+
+- [Install python 3.7.\* (take 64bit version!)](https://www.python.org/downloads/windows)
+- In a command shell (`cmd.exe`), run:
+
+        pip install music_sampler
+        pip install docutils pygments pypiwin32 PySDL2 kivy.deps.sdl2 kivy.deps.glew
+
+- [Install ffmpeg (64bit, static)](https://ffmpeg.zeranoe.com/builds/)
+  and put the content of folder `bin` in the same folder as music and configs.
+- [Download Ubuntu font](https://www.1001fonts.com/ubuntu-font.html)
+  and install Ubuntu-R and Ubuntu-B (Regular and Bold) *for all users* (right clic on the font)
+- [Download Symbola font](https://fontlibrary.org/en/font/symbola)
+  and install it *for all users* (right clic on the font)
+- Write a `run.bat` file with:
+
+        :::bash
+        @echo off
+        music_sampler
+
+- Run this `run.bat` when you need it.
+
 ## Compiled version
 
 A compiled version can be created with `pyinstaller`:
@@ -225,6 +252,7 @@ protected for 2 seconds after each stroke.
 - `repeat_delay: x` (default 0) : protection delay. Once all its actions are
   done, the key will remain disabled (semi-transparent and crossed) for that
   amount of time (in seconds).
+- `actions: list`: List of actions to run with the key.
 
 #### `common` key property
 
@@ -237,6 +265,8 @@ This section lets you describe for each key, the list of actions associated to
 it. Note that except for `wait` and some particular cases (see below), all the
 actions are almost instantaneous.
 
+*This section is deprecated and replaced by an `actions` key containing a list
+in `key_properties` section for each key.*
 
 #### Examples
 
@@ -318,6 +348,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:
@@ -386,9 +418,22 @@ actions.
       action. When false, it is thus useless to add actions after that one.
 - `interrupt_wait`: stop a wait event (normal `wait` or fade out wait). The keys
   that were waiting will move to the next actions. Parameters:
-    * `wait_id: name` : gives the id of the `wait` to interrupt (defined with
-      `set_wait_id`, see actions `wait` and `stop`). To interrupt several waits,
-      use the same action several times.
+    * `wait_id: name` (optional) gives the id of the `wait` to interrupt
+      (defined with `set_wait_id`, see actions `wait` and `stop`). If not given,
+      interrupts all wait events.
+- `pause_wait`: pauses a wait event (only for a wait with duration). The key
+  that were waiting will keep waiting until the `wait` is unpaused. Parameters:
+    * `wait_id: name` (optional) gives the id of the `wait` to pause. If not
+      given, pauses all compatible wait events.
+- `unpause_wait`: unpauses a paused wait event (only a wait with duration). The
+  countdown will resume for the corresponding keys. Parameters:
+    * `wait_id: name` (optional) gives the id of the `wait` to unpause. If not
+      given, unpauses all compatible wait events.
+- `reset_wait`: resets a wait counter (only a wait with duration). If the wait
+  was paused, it will stay paused and start at the beginning once it is
+  unpaused. Parameters:
+    * `wait_id: name` (optional) gives the id of the `wait` to reset. If not
+      given, resets all compatible wait events.
 - `run_command` : Run a command. Parameters:
     * `command: my_command` : Gives the command to run.
     * `wait: true/false` (optional, default false) if true, waits for the