From 6a1aef21936efdf18b8c6a3bbffe050766969c3a Mon Sep 17 00:00:00 2001
From: Maximilien Naveau <maximilien.naveau@gmail.com>
Date: Mon, 9 May 2022 14:57:42 +0200
Subject: [PATCH] Update readme

---
 README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 74 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index a2e136a..bff8223 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,7 @@
-
-
 Pousse Seringue / Arduino / ESP8266 / LAAS-HW
+=============================================
 
-Données préliminaires
----------------
+## Données préliminaires
 
 - Hardware
   - [A4988 breakout](https://www.pololu.com/file/0J450/a4988_DMOS_microstepping_driver_with_translator.pdf)
@@ -18,3 +16,75 @@ Données préliminaires
   - [Web UI](https://github.com/s00500/ESPUI.git)
   - [Stepper Driver](https://github.com/laurb9/StepperDriver)
   - [OLED](https://github.com/greiman/SSD1306Ascii)
+
+## Installation des drivers et outils de compilation
+
+### Installer toutes les dépendences:
+
+Créer un espace de travail: `mkdir -p ~/devel/workspace/src`
+
+Cloner les paquets suivant dans le dossier `~/devel/workspace/src`.
+- [Compiler and driver pour le esp8266 arduino (coeur arduino).](https://github.com/esp8266/Arduino/)
+- [Fournisseur d'interface web pour arduino.](https://github.com/s00500/ESPUI)
+  On l'utilise pour l'interface graphique
+- [Compilation locale de l'interface graphique web.](https://github.com/d-a-v/emuAsync)
+- [WebSocket driver pour arduino.](https://github.com/Links2004/arduinoWebSockets)
+  Utilisé pour la compilation locale de l'interface graphique web.
+- [Parseur de fichier Json pour arduino.](https://github.com/bblanchon/ArduinoJson)
+
+```
+mkdir -p ~/devel/workspace/src
+cd ~/devel/workspace/src
+git clone --recursive git@github.com:esp8266/Arduino.git arduino_esp8266
+git clone --recursive git@github.com:s00500/ESPUI.git
+git clone --recursive git@github.com:d-a-v/emuAsync.git
+git clone --recursive https://github.com/Links2004/arduinoWebSockets.git
+git clone --recursive https://github.com/bblanchon/ArduinoJson.git
+```
+
+On récupère la chaine d'outil pour compiler sur arduino
+```
+cd ~/devel/workspace/src/arduino_esp8266/tools/
+./get.py
+```
+
+Pensez à verifier l'installation en suivant les instruction du paragraph suivant.
+
+### Vérification de l'installation:
+
+#### Emulation de l'interface graphique
+
+Pour verifier sir l'émulateur fonction on fait tourner un test unitaire d'ESPUI.
+```
+export ESP8266ARDUINO=~/devel/workspace/src/arduino_esp8266
+export ARDUINOLIB=~/devel/workspace/src/
+cd ~/devel/workspace/src/
+./emuAsync/tests/ESPUI-gui
+```
+Cela devrait compiler le test et creer un executable `gui`.
+Celui ci se trouve afficher dans le terminal entre deux flèches:
+```
+----> ~/devel/workspace/src/arduino_esp8266/tests/host/bin/gui/gui <----
+```
+Vous l'éxecuter:
+```
+~/devel/workspace/src/arduino_esp8266/tests/host/bin/gui/gui
+```
+Et vous ouvrez firefox sur localhost:9080:
+```
+firefox localhost:9080
+```
+
+## Compiler et flasher la carte:
+
+### IDE Arduino
+
+@todo
+
+### PlaterformIO
+
+@todo
+
+### ESP
+
+@todo
\ No newline at end of file
-- 
GitLab