docs: 📝 add per workspace readme

This commit is contained in:
Julien Oculi 2024-06-26 14:45:29 +02:00
parent e316d3a608
commit 23fa6aa887
3 changed files with 24 additions and 0 deletions

3
client/.vscode/extensions.json vendored Normal file
View file

@ -0,0 +1,3 @@
{
"recommendations": ["ritwickdey.liveserver"]
}

9
client/README.md Normal file
View file

@ -0,0 +1,9 @@
# Client
Code pour l'interface utilisateur via le web.
## Usage
Ouvrir [index.html](./index.html) dans un navigateur ou avec
[Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)
sur VS Code.

12
server/README.md Normal file
View file

@ -0,0 +1,12 @@
# Server
Code pour l'ESP32 (code embarqué dans le robot).
## Usage
Commenter un des 2 points d'entrée dans [src](./src/) et lancer `pio run` ou
équivalent. Mettre à jour la configuration WiFi dans [config](./src/config.h) et
[server](./src/server.hpp) pour téléverser vers l'ESP32. Sinon lancer le
simulateur [Wokwi](https://docs.wokwi.com/vscode/getting-started) dans VS Code
ou copier le code pour le lancer dans le navigateur sur
[wokwi.com](https://wokwi.com/).