Add documentation for windows install

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

diff --git a/documentation_en.md b/documentation_en.md
index e92b85c60d69a53cd489336c9fb0dae722440749..ee95ad38da5af6ab2092bb6920495527295b95d7 100644 (file)
--- 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