Improved README.md
Some checks failed
Build & Publish / build (push) Failing after 1m47s

This commit is contained in:
Florian Kaiser 2023-08-08 08:35:04 +02:00
parent 609ac04433
commit aba0cec34d
Signed by: H4CK3R-01
SSH Key Fingerprint: SHA256:Zh0ZE/S6X5mfivz9uLnbQizfkJfEQTjL8FlWbPqhqk0

View File

@ -1,5 +1,37 @@
# Zephyr configurator
## Project structure
### File structure
```
├── data
│ ├── app.overlay
│ ├── CMakeLists.txt
│ ├── main.c
│ ├── prj.conf
│ └── VERSION
├── Dockerfile
├── Entwicklungsleitfaden.md
├── images
│ ├── ...
├── README.md
├── script.sh
└── snippets
├── ...
```
`data` contains the empty project, that is used to generate a new project \
`images` contains images for the documentation \
`snippets` contains code snippets for functions \
`script.sh` main script
### Snippets
The snippets are used to add new functions to the project. Each function has one directory with one or more files.
To add new functions, you have to create a new directory in the `snippets`-directory and adjust the script.
### script.sh
The main script that is the entrypoint of the docker container
## Run
### [Optional] Build manually
```