Updated docs (#56)

This commit is contained in:
Ken Van Hoeylandt 2024-08-31 18:05:30 +02:00 committed by GitHub
parent 27730260e0
commit 660833f2ec
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -120,7 +120,7 @@ The build scripts will detect if ESP-IDF is available. They will adapter if you
### Development ### Development
Take a look at the [App Lifecycle](docs/app-lifecycle.md). Take a look at the [App Lifecycle](docs/app-lifecycle.md) or the [dependency diagram](docs/project-structure.puml) (this uses [PlantUML](https://plantuml.com)).
Directories explained: Directories explained:
@ -128,7 +128,7 @@ Directories explained:
- `app-sim`: The PC/simulator application example - `app-sim`: The PC/simulator application example
- `boards`: Contains ESP modules with drivers - `boards`: Contains ESP modules with drivers
- `tactility`: The main application platform code ([src/](./tactility/src)) - `tactility`: The main application platform code ([src/](./tactility/src))
- `tactility-esp`: ESP-specific application code (e.g. wifi app and service) - `tactility-headless`: Service framework and default services.
- `tactility-core`: Core functionality regarding threads, stdlib, etc. ([src/](./tactility-core/src)) - `tactility-core`: Core functionality regarding threads, stdlib, etc. ([src/](./tactility-core/src))
- `libs`: Contains a mix of regular libraries and ESP modules - `libs`: Contains a mix of regular libraries and ESP modules