docs: add App specification #67
Conversation
per1234
added
documentation
docs/app-specification.md
Outdated
|
|
||
| The `app.yaml` (or `app.yml`) is a YAML file that describes an App. | ||
|
|
||
| - `name`: (optional) a short name of the app. |
There was a problem hiding this comment.
I've removed the optional piece. Maybe we should just specify what's mandatory, implying that everything else is optional.
There was a problem hiding this comment.
Or, better, we should provide a JSON SCHEMA file (as we did for the Arduino CLI configuration) https://github.com/arduino/arduino-cli/blob/master/internal/cli/configuration/configuration.schema.json
There was a problem hiding this comment.
BTW, currently an empty app.yaml is valid and the ardiuno-app-cli is able to run it.
arduino@merola:~/ArduinoApps/my-app$ cat app.yaml
| ### Other | ||
|
|
||
| Other sub-folders or files can be added to the app folder. | ||
| The reserved folder names are `sketch` and `python`. | ||
| The reserved file names are `app.yaml` and `sketch.yaml`. |
There was a problem hiding this comment.
I think we should discourage adding extra files in the root folder; maybe we could reserve an extras folder for user-specific data.
| - `name`: A short name of the app. | ||
| - `description`: A brief description of the app. | ||
| - `icon`: The emoji of the app. | ||
| - `ports`: A list of TCP ports to be exposed externally. If not given a random port is opened (if necessary). |
There was a problem hiding this comment.
What does it mean that it opens a "random" port? 🤔 What is this port used for?
| - `description`: A brief description of the app. | ||
| - `icon`: The emoji of the app. | ||
| - `ports`: A list of TCP ports to be exposed externally. If not given a random port is opened (if necessary). | ||
| - `bricks`: A list of bricks used by the app with its variable definitions. |
There was a problem hiding this comment.
What's a "brick"? There is an entire session missing that explains what a "brick" is.
5 participants
Motivation
Change description
Additional Notes
Reviewer checklist
main.