From ce224ede98a3afbb12b1d028c6f3574c9dad7bac Mon Sep 17 00:00:00 2001 From: Julien Oculi Date: Wed, 26 Jun 2024 14:55:33 +0200 Subject: [PATCH] docs: :memo: add repo readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b3ac134 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Fork "Mon premier robot" + +Tentative de re-factorisation du code et d'amélioration de UI web du robot de +l'[Atelier Printemps 2024 - MON PREMIER ROBOT](https://projets.cohabit.fr/redmine/projects/ateliers/wiki/Atelier_Printemps_2024). + +## Usage + +Ouvrir le workspace [robot.code-workspace](./robot.code-workspace) dans VS Code +pour un environnement déjà configurer. + +### Client + +Testé dans Chrome (pc/android) et Firefox (pc) avec +[live server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer). + +### Server + +Compilé avec la cli [Platform IO](https://platformio.org/) +(`cd ./server && pio run`). Testé avec le simulateur [Wokwi](https://wokwi.com/) +en ligne et sur VS Code.