Skip to content

Commit a9cabb3

Browse files
committed
Updated docs
1 parent ebafc23 commit a9cabb3

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/sketch-project-file.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ Each profile will define:
1414
- The target core platform name and version (with the 3rd party platform index URL if needed)
1515
- A possible core platform name and version, that is a dependency of the target core platform (with the 3rd party
1616
platform index URL if needed)
17-
- The libraries used in the sketch (including their version)
17+
- A list of libraries used in the sketch. Each library could be:
18+
- a library taken from the Arduino Libraries Index
19+
- a library installed anywhere in the filesystem
1820
- The port and protocol to upload the sketch and monitor the board
1921

2022
The format of the file is the following:
@@ -31,9 +33,8 @@ profiles:
3133
- platform: <PLATFORM_DEPENDENCY> (<PLATFORM_DEPENDENCY_VERSION>)
3234
platform_index_url: <3RD_PARTY_PLATFORM_DEPENDENCY_URL>
3335
libraries:
34-
- <LIB_NAME> (<LIB_VERSION>)
35-
- <LIB_NAME> (<LIB_VERSION>)
36-
- <LIB_NAME> (<LIB_VERSION>)
36+
- <INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)
37+
- dir: <LOCAL_LIB_PATH>
3738
port: <PORT_NAME>
3839
port_config:
3940
<PORT_SETTING_NAME>: <PORT_SETTING_VALUE>
@@ -55,7 +56,11 @@ otherwise below). The available fields are:
5556
information as `<PLATFORM>`, `<PLATFORM_VERSION>`, and `<3RD_PARTY_PLATFORM_URL>` respectively but for the core
5657
platform dependency of the main core platform. These fields are optional.
5758
- `libraries:` is a section where the required libraries to build the project are defined. This section is optional.
58-
- `<LIB_VERSION>` is the version required for the library, for example, `1.0.0`.
59+
- `<INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)` represents a library from the Arduino Libraries Index, for example,
60+
`MyLib (1.0.0)`.
61+
- `dir: <LOCAL_LIB_PATH>` represents a library installed in the filesystem and `<LOCAL_LIB_PATH>` is the path to the
62+
library. The path could be absolute or relative to the sketch folder. This option is available since Arduino CLI
63+
1.3.0.
5964
- `<USER_NOTES>` is a free text string available to the developer to add comments. This field is optional.
6065
- `<PROGRAMMER>` is the programmer that will be used. This field is optional.
6166

0 commit comments

Comments
 (0)