Skip to content

Commit cab7e9a

Browse files
committed
Make FAQ content applicable to all official Arduino development software
At the time it was created, there was only one official Arduino development application: Arduino IDE. Since that time, Arduino Web Editor and Arduino CLI have been created, both of which implement Library Manager in their own manners.
1 parent f6fb08a commit cab7e9a

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

FAQ.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,19 @@
22

33
### What is the Arduino Library Manager?
44

5-
Library Manager is a feature of the Arduino IDE (**Sketch > Include Library > Manage Libraries...**) which makes it easy for users to find, install, and update both official and 3rd party libraries.
5+
Library Manager is a feature of the Arduino development software which makes it easy for users to find, install, and update both official and 3rd party libraries.
66

7-
When a library is [added to the library list](README.md#adding-a-library-to-library-manager), every release of the library will automatically be made available for installation via Library Manager. The users can set their preferences to display an update notification when a new version of any installed library on the list is available and easily update to the new version with just a couple clicks.
7+
- In the Arduino IDE: **Sketch > Include Library > Manage Libraries...**
8+
- In Arduino CLI: `arduino-cli lib --help`
9+
- In Arduino Web Editor: all Library Manager libraries are pre-installed.
810

9-
More information: <br />
10-
https://www.arduino.cc/en/Guide/Libraries#toc3
11+
When a library is [added to the library list](README.md#adding-a-library-to-library-manager), every release of the library will automatically be made available for installation via Library Manager. Users can set their preferences to display an update notification when a new version of any installed library on the list is available and easily update to the new version with just a couple clicks.
12+
13+
More information:
14+
15+
- https://www.arduino.cc/en/Guide/Libraries#toc3
16+
- https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_lib/
17+
- https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-on-various-platforms-4b3e4a
1118

1219
### What are the requirements for a library to be added to Library Manager?
1320

@@ -88,11 +95,17 @@ If you wish to change the name it will need to be done manually by request:
8895

8996
### How can I remove a library I installed via Library Manager?
9097

91-
Open your sketchbook's `libraries` folder with your operating system's file explorer (Windows: Explorer, Mac: Finder, Linux: Nautilus, kfiles...) and delete the folder containing the library.
98+
#### Arduino IDE 2.x
99+
100+
Hover the mouse pointer over the "INSTALLED" label on the library listing in Library Manager. It will now change to "UNINSTALL", which you can click to uninstall that library.
92101

93-
##### Rationale
102+
#### Classic Arduino IDE
94103

95-
No, we don't have a delete button. Libraries managed by the Library Manager are mixed with those you've manually installed, maybe libraries you've written: making a mistake and deleting the wrong library is too easy. That's why Trash bins exist. Since the IDE has no knowledge of your Trash bin, we didn't implement a "delete" button.
104+
This version of the Arduino IDE does not have an integrated uninstall functionality, so you will need to remove the library manually. Open your sketchbook's `libraries` folder with your operating system's file explorer (Windows: Explorer, Mac: Finder, Linux: Nautilus, kfiles...) and delete the folder containing the library.
105+
106+
#### Arduino CLI
107+
108+
Libraries can be uninstalled via [the `arduino-cli lib uninstall` command](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_lib_uninstall/).
96109

97110
## Limitations
98111

@@ -106,12 +119,14 @@ No. The library archive distributed by Library Manager will only contain an empt
106119

107120
### Can I add my own URL with my own library index?
108121

109-
No. At the moment, the IDE handles one URL only, and that's written into the code (dev jargon: it's hardcoded), this is a known limitation.
122+
No. At the moment, the Arduino development software handles one URL only, and that's written into the code (dev jargon: it's hardcoded), this is a known limitation.
110123
However, if you know your way through the code, you can change that URL with another one.
111124

112125
### When I install a library that I know depends on another library, will this other library be installed as well?
113126

114-
You can specify the dependencies of your library in the `depends` field of library.properties. As of Arduino IDE 1.8.10, the user will be prompted to install those libraries when they install your library via Library Manager. For more information, see the [`library.properties` file format documentation](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format).
127+
As of Arduino IDE 1.8.10 and Arduino CLI 0.7.0, you can specify the dependencies of your library in the `depends` field of library.properties. Those libraries can be installed automatically when someone installs your library via Library Manager.
128+
129+
For more information, see the [`library.properties` file format documentation](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format).
115130

116131
### Can I install multiple versions of one library and use the proper one in my sketches?
117132

0 commit comments

Comments
 (0)