docs: 📝 add repo readme

This commit is contained in:
Julien Oculi 2024-06-26 14:55:33 +02:00
parent 23fa6aa887
commit ce224ede98

20
README.md Normal file
View file

@ -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.