Skip to content

Commit 5987f00

Browse files
committed
Document library dependencies installation path
The user may wish to compile sketches bundled with the installed library. In the absense of documentation, it would be challenging to determine where the installed libraries were located.
1 parent 757ebee commit 5987f00

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ YAML-format list of platform dependencies to install.
2222

2323
Default `""`. If no `platforms` input is provided, the board's dependency will be automatically determined from the `fqbn` input and the latest version of that platform will be installed via Board Manager.
2424

25-
If a platform dependency from a non-Board Manager source of the same name as another Board Manager source platform dependency is defined, they will both be installed, with the non-Board Manager dependency overwriting the Board Manager platform installation. This permits testing against a non-release version of a platform while using Board Manager to install the platform's tools dependencies.
25+
If a platform dependency from a non-Board Manager source of the same name as another Board Manager source platform dependency is defined, they will both be installed, with the non-Board Manager dependency overwriting the Board Manager platform installation. This permits testing against a non-release version of a platform while using Board Manager to install the platform's tools dependencies.
2626
Example:
2727
```yaml
2828
platforms: |
@@ -68,14 +68,16 @@ YAML-format list of library dependencies to install.
6868

6969
Default `"- source-path: ./"`. This causes the repository to be installed as a library. If there are no library dependencies and you want to override the default, set the `libraries` input to an empty list (`- libraries: '-'`).
7070

71+
Libraries are installed under the Arduino user folder at `~/Arduino/libraries`.
72+
7173
Note: the original space-separated list format is also supported. When this syntax is used, the repository under test will always be installed as a library.
7274

7375
#### Sources:
7476

7577
##### Library Manager
7678

7779
Keys:
78-
- `name` - name of the library.
80+
- `name` - name of the library, as defined in the `name` field of its [library.properties](https://arduino.github.io/arduino-cli/library-specification/#libraryproperties-file-format) metadata file. The library will be installed to a folder matching the name, but with any spaces replaced by `_`.
7981
- `version` - version of the library to install. Default is the latest version.
8082

8183
##### Local path

0 commit comments

Comments
 (0)