Add UI destop application

update requirement and new doc link in UI

Author: Orthopus-Captain

.gitignore

@@ -0,0 +1,2 @@
+**/venv/
+*.pyc

README.md

@@ -55,7 +55,7 @@ Follow the [manufacturing manual](./docs/manufacturing-manual.md)
 
 **:three: Flash the Arduino Board**
 
-Follow the [arduino programming manual](./docs/firmware-programming-manual.md)
+Follow the [firmware programming manual](./docs/firmware-programming-manual.md)
 
 **:four: Install the Desktop GUI**
 
@@ -68,4 +68,4 @@ Your contribution to the MyoCoach project is welcome!
 * Have you discovered a bug or you have an improvement ideas ?
   * Go to the GitHub [issues](https://github.com/orthopus/0113-myocoach-diy/issues) of the project.
 * You have time, some Maker skills and you want to help us ?
-  * Read the [CONTRIBUTING](CONTRIBUTING.md) file to help us to go to the **Myo Coach** v2.0
+  * Read the [CONTRIBUTING](CONTRIBUTING.md) file to help us to go to the **Myo Coach v2.0**

docs/ui-programming-manual.md

@@ -0,0 +1,42 @@
+# 0113-MyoCoach-DIY :<br>UI Programming Manual
+
+This desktop application allows the visualization of raw EMG signals and allows users to train by observing the raw signals or through a game which is a clone inspired by [FlapPyBird](https://github.com/sourabhv/FlapPyBird) with a different game system.
+
+The MyoCoach application is based on python3 with PyQt5.
+
+## Installation
+
+Tested under MacOS and Linux.
+
+**:one: Installing the dependencies**
+
+Install the following packages :
+* [Python](https://www.python.org/downloads) (3.6.x or higher) ;
+* [pip](https://techworm.net/programming/install-pip-python-mac-windows-linux/) (20.0.x or later);
+
+Install `virtualenv` :
+```
+pip install virtualenv
+```
+
+**:two: Installing the main program**
+
+Open a terminal, go to the `src/software/ui` folder and launch the installation :
+
+```
+$ cd src/software/ui/
+make install
+```
+
+This command creates a _virtualenv_ and installs the necessary dependencies for the application. These dependencies are listed in the [src/software/ui/requirements.txt](../src/software/ui/requirements.txt) file.
+
+**:three: Launch the application**
+
+```
+$ make play
+```
+
+## ScreenShot
+
+![Signal Widget](assets/screenShot_signal.png)
+![FlappyBird Widget](assets/screenShot_flappybird.png)

docs/user-manual.md

@@ -106,7 +106,7 @@ This test protocol allows the placement of two electrodes which are useful for t
 
 ![muscle_flechisseur_et_extenseur](./assets/muscle_flechisseur_et_extenseur.png)
 
-* :one: Equip an electrode with a pin header strip to make an adapter with the MyoCoach connector system (see the electrode connector section in the [manufacturing-manual](manufacturing-manual)).
+* :one: Equip an electrode with a pin header strip to make an adapter with the MyoCoach connector system (see the electrode connector section in the [manufacturing-manual](./manufacturing-manual.md)).
 
 ![adpatateur_electrode](./assets/adpatateur_electrode.png)
 
@@ -191,4 +191,5 @@ The game play has been modified to better correspond to the use of EMG sensors b
 * Use the computer **keyboard Space** ⌨️ to start or restart the game.
 
 ![record_bionico](./assets/record_bionico.png)
+
 Record by Bionico :boom:

src/software/ui/Credit.txt

@@ -0,0 +1 @@
+Icon made by strip from www.flaticon.com

src/software/ui/Makefile

@@ -0,0 +1,8 @@
+.PHONY: install
+install:
+	python3 -m virtualenv -p python3 venv
+	venv/bin/pip install -r requirements.txt
+
+.PHONY: play
+play:
+	venv/bin/python3 myocoach.py