Skip to content

Commit 189fcb9

Browse files
committed
docs: clarify Arduino App folder structure and reserved names
1 parent d13cf8a commit 189fcb9

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/app-specification.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# Arduino App specification
22
This is the specification for the `Arduino App` (from now on called App) format to be used with `arduino-app-cli` and `Arduino App Lab`.
33

4-
## Arduino App Folder structure
4+
# Arduino App Folder structure
55
An App is a self-contained folder that includes the following components:
66
- `app.yaml` (mandatory) the file descriptor of the app in YAML format.
77
- `sketch` (optional) the folder containing an Arduino [Sketch](https://arduino.github.io/arduino-cli/1.3/sketch-specification/)).
88
- `python` (optional) the folder containing the Python code.
9-
At least one on `sketch` or `python` folder must be present.
109

10+
At least one on `sketch` or `python` folder must be present.
1111
The App must be self-contained (it does not contain references to external files) because this means it can be exported, shared, or zipped easily.
1212

13+
The user-defined apps are saved into `/home/arduino/ArduinoApps` folder.
14+
The builtin-apps are
15+
16+
1317
Example of a `my-app` folder structure
1418
```
1519
my-app/
@@ -70,4 +74,6 @@ If present, it must contain the `main.py` with the python code of the main.
7074
Optionally, a `requirements.txt` with additional python package dependencies to be installed.
7175

7276
### Other
73-
The folder can be added to the folder structure
77+
Other sub-folders or files can be added to the app folder.
78+
The reserved folder names are `sketch` and `python`.
79+
The reserved file names are `app.yaml` and `sketch.yaml`.

0 commit comments

Comments
 (0)