@@ -14,7 +14,9 @@ Each profile will define:
14
14
- The target core platform name and version (with the 3rd party platform index URL if needed)
15
15
- A possible core platform name and version, that is a dependency of the target core platform (with the 3rd party
16
16
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
18
20
- The port and protocol to upload the sketch and monitor the board
19
21
20
22
The format of the file is the following:
@@ -31,9 +33,8 @@ profiles:
31
33
- platform: <PLATFORM_DEPENDENCY> (<PLATFORM_DEPENDENCY_VERSION>)
32
34
platform_index_url: <3RD_PARTY_PLATFORM_DEPENDENCY_URL>
33
35
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>
37
38
port: <PORT_NAME>
38
39
port_config:
39
40
<PORT_SETTING_NAME>: <PORT_SETTING_VALUE>
@@ -55,7 +56,11 @@ otherwise below). The available fields are:
55
56
information as ` <PLATFORM> ` , ` <PLATFORM_VERSION> ` , and ` <3RD_PARTY_PLATFORM_URL> ` respectively but for the core
56
57
platform dependency of the main core platform. These fields are optional.
57
58
- ` 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.
59
64
- ` <USER_NOTES> ` is a free text string available to the developer to add comments. This field is optional.
60
65
- ` <PROGRAMMER> ` is the programmer that will be used. This field is optional.
61
66
0 commit comments