Skip to content

Commit a49dd21

Browse files
committed
Updated docs
1 parent c29cc2f commit a49dd21

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/sketch-project-file.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ profiles:
2626
fqbn: <FQBN>
2727
programmer: <PROGRAMMER>
2828
platforms:
29-
- platform: <PLATFORM> (<PLATFORM_VERSION>)
29+
- platform: <PLATFORM> [(<PLATFORM_VERSION>)]
3030
platform_index_url: <3RD_PARTY_PLATFORM_URL>
31-
- platform: <PLATFORM_DEPENDENCY> (<PLATFORM_DEPENDENCY_VERSION>)
31+
- platform: <PLATFORM_DEPENDENCY> [(<PLATFORM_DEPENDENCY_VERSION>)]
3232
platform_index_url: <3RD_PARTY_PLATFORM_DEPENDENCY_URL>
3333
libraries:
3434
- <LIB_NAME> (<LIB_VERSION>)
@@ -68,6 +68,14 @@ The following fields are available since Arduino CLI 1.1.0:
6868
`baudrate: 115200`) but any setting/value can be specified. Multiple settings can be set. These fields are optional.
6969
- `<PORT_PROTOCOL>` is the protocol for the port used to upload and monitor the board. This field is optional.
7070

71+
#### Using a system-installed platform.
72+
73+
The fields `<PLATFORM_VERSION>` and `<PLATFORM_DEPENDENCY_VERSION>` are optional, if they are omitted, the sketch
74+
compilation will use the platforms installed system-wide. This could be helpful during the development of a platform
75+
(where a specific release is not yet available), or if a specific version of a platform is not a strict requirement.
76+
77+
#### An example of a complete project file.
78+
7179
A complete example of a sketch project file may be the following:
7280

7381
```

0 commit comments

Comments
 (0)