Skip to content

Commit f6fb08a

Browse files
committed
Reword FAQ text to improve readability
A general pass of minor rewording.
1 parent d7d89ff commit f6fb08a

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

FAQ.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

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

5-
The Arduino 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. When your library is added to the library list, every release/tag version of the library in your repository 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. More information: <br />
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.
6+
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.
8+
9+
More information: <br />
610
https://www.arduino.cc/en/Guide/Libraries#toc3
711

812
### What are the requirements for a library to be added to Library Manager?
@@ -42,13 +46,13 @@ Every hour, the automated Library Manager indexer system:
4246

4347
### How can I add my library to Library Manager?
4448

45-
Follow the submission instructions [here](README.md#adding-a-library-to-library-manager).
49+
Follow the instructions [here](README.md#adding-a-library-to-library-manager).
4650

4751
### How can I publish a new release once my library is in the list?
4852

4953
1. Make sure the library is compliant with [all requirements](#update-requirements).
50-
1. Update the `version` in your `library.properties`.
51-
1. Tag your library once more and push the new tag (or create a release if your web hosting offers a way to do it, for example with GitHub "releases").
54+
1. Update the `version` in your [`library.properties`](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata)).
55+
1. Tag your library once more and push the new tag (or create a release if your Git-hosting site offers a way to do it, for example with [GitHub "releases"](https://help.github.com/articles/creating-releases/)).
5256

5357
[Our indexer](#how-is-the-library-manager-index-generated) checks for new releases every hour and will eventually fetch and publish your new release.
5458

@@ -60,7 +64,7 @@ Follow the submission instructions [here](README.md#adding-a-library-to-library-
6064
- [ ] The `name` property in library.properties must not have changed from the value it had when the library was submitted. If you must change the library name, see [this](#how-can-i-change-my-librarys-name).
6165
- [ ] The `version` property in library.properties must not be the same as it was in a tag previously added to the Library Manager index.
6266

63-
### Sorry, I did something wrong! How can I change or unpublish an already published library?
67+
### I did something wrong! How can I change or unpublish an already published library?
6468

6569
In order to change contents of an already published library version, you can recreate its related tag.
6670

@@ -79,20 +83,20 @@ For the sake of continuity, libraries in the Library Manager list are locked to
7983
If you wish to change the name it will need to be done manually by request:
8084

8185
1. Change the `name` value in your [library.properties file](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format) and update the `version`.
82-
1. Create a release or tag that matches the updated `version` value in library.properties.
83-
1. Submit an [issue report](https://github.com/arduino/library-registry/issues) requesting the name be changed and the URL of your library's repository.
86+
1. Create a release or tag.
87+
1. Submit an [issue report](https://github.com/arduino/library-registry/issues) requesting the name be changed and stating the URL of your library's repository.
8488

85-
### How can I delete a library?
89+
### How can I remove a library I installed via Library Manager?
8690

87-
Open your sketchbook's `libraries` folder with your OS file explorer (Windows: Explorer, Mac: Finder, Linux: Nautilus, kfiles...) and delete the folder containing your library.
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.
8892

8993
##### Rationale
9094

91-
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.
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.
9296

9397
## Limitations
9498

95-
### Is my Git repo OK?
99+
### Is my Git repository OK?
96100

97101
Your repo is OK if it meets all [the requirements listed here](#submission-requirements).
98102

0 commit comments

Comments
 (0)