Skip to content

Commit 061d56d

Browse files
committed
Document that automated library dependencies are installed
Library authors may define dependencies of the library in the `depends` field of its library.properties metadata file. These dependencies are automatically installed for libraries sourced from Library Manager.
1 parent 040a3f4 commit 061d56d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,14 @@ Libraries are installed under the Arduino user folder at `~/Arduino/libraries`.
9191
##### Library Manager
9292

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

98+
**Notes**:
99+
- The library will be installed to a folder matching its name, but with any spaces replaced by `_`.
100+
- If the library's author defined dependencies, those libraries will be installed automatically.
101+
98102
##### Local path
99103

100104
Keys:

0 commit comments

Comments
 (0)