docs: 📝 add and update readme of all modules

This commit is contained in:
Julien Oculi 2024-03-07 14:03:20 +01:00
parent df4f02be39
commit 580cce1cbf
7 changed files with 52 additions and 14 deletions

8
electronic/README.md Normal file
View file

@ -0,0 +1,8 @@
# Electronic
This module contains all electronic behavior of the **Gowest** project:
- Sketchs.
- Contrains (components values, ...).
- Electronic components list.
- ...

11
electronic/deno.json Normal file
View file

@ -0,0 +1,11 @@
{
"name": "electronic",
"version": "0.1.0",
"importMap": "../import_map.json",
"fmt": {
"singleQuote": true,
"useTabs": true,
"semiColons": false,
"indentWidth": 4
}
}

View file

@ -0,0 +1,3 @@
# Music
This module contains the "singing plants" sub-project of the **Gowest** project.

View file

@ -0,0 +1,8 @@
# Robot
This module contains all vehicle control aspect of the **Gowest** project running on a Raspberry Pi 4:
- Code.
- Build scripts.
- AI model (source and datas) to convert `translator` module inputs into vehicle controls.
- ...

View file

@ -0,0 +1,8 @@
# Sketch
This module contains all CAD and materials needed for building the **Gowest** vehicle:
- Sketchs.
- Materials used.
- CAO, STL and other 3D files.
- ...

View file

@ -0,0 +1,8 @@
# Translator
This module contains the API for the [Vegetal Signals](https://vegetalsignals.com/) box to translate plants signals into parsed and filtered datas:
- Code.
- Configurations.
- Tests.
- ...

View file

@ -1,16 +1,8 @@
# Fresh project
# Web
Your new Fresh project is ready to go. You can follow the Fresh "Getting
Started" guide here: https://fresh.deno.dev/docs/getting-started
This module contains the web interface to configure, manage, and communicate with the **Gowest** vehicle:
### Usage
Make sure to install Deno: https://deno.land/manual/getting_started/installation
Then start the project:
```
deno task start
```
This will watch the project directory and restart as necessary.
- Server.
- Client.
- Views.
- ...