arduino/library-registry
1
0
Fork 0
mirror of https://github.com/arduino/library-registry.git synced 2025-04-19 03:42:17 +03:00
Code

Move compatibility anchors above documentation headings

Browse Source 
These anchor tags provide compatibility with links created before the heading text was changed (anchors are automatically
generated for headings). Placing them below the headings caused the page to be scrolled to below the headings when
visited via their links.
This commit is contained in:
per1234 2021-05-25 07:15:15 -07:00
parent 1d1f4a19d2
commit bc1ae9e407
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
FAQ.md
View File

@ -60,16 +60,16 @@ Every hour, the automated Library Manager indexer system:
## Submission ## Submission
### How can I add a library to Library Manager?
<a id="how-can-i-add-my-library-to-library-manager"></a> <a id="how-can-i-add-my-library-to-library-manager"></a>
### How can I add a library to Library Manager?
Follow the instructions [here](README.md#adding-a-library-to-library-manager). Follow the instructions [here](README.md#adding-a-library-to-library-manager).
### What are the requirements for a library to be added to Library Manager?
<a id="submission-requirements"></a> <a id="submission-requirements"></a>
### What are the requirements for a library to be added to Library Manager?
- [ ] The library must be fully compliant with the [Arduino Library Specification](https://arduino.github.io/arduino-cli/latest/library-specification). - [ ] The library must be fully compliant with the [Arduino Library Specification](https://arduino.github.io/arduino-cli/latest/library-specification).
- [ ] The library must have [a library.properties file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata), in compliance with the Arduino Library 1.5 format. - [ ] The library must have [a library.properties file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata), in compliance with the Arduino Library 1.5 format.
- [ ] The library.properties file must be located in the root of the repository. - [ ] The library.properties file must be located in the root of the repository.
@ -106,10 +106,10 @@ Note that libraries will need to be compliant with [all requirements](#update-re
[Our indexer](#how-is-the-library-manager-index-generated) checks for new releases every hour and will eventually fetch and publish the new release. [Our indexer](#how-is-the-library-manager-index-generated) checks for new releases every hour and will eventually fetch and publish the new release.
### What are the requirements for publishing new releases of libraries already in the Library Manager list?
<a id="update-requirements"></a> <a id="update-requirements"></a>
### What are the requirements for publishing new releases of libraries already in the Library Manager list?
- [ ] The library must be compliant with all the same [requirements that apply to submissions](#submission-requirements). - [ ] The library must be compliant with all the same [requirements that apply to submissions](#submission-requirements).
- [ ] 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). - [ ] 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).
- [ ] The `version` property in library.properties must not be the same as it was in a tag previously added to the Library Manager index. - [ ] The `version` property in library.properties must not be the same as it was in a tag previously added to the Library Manager index.
@ -140,10 +140,10 @@ In order to **un**publish a library version, delete its related tag/release.
Once you have done that, open an issue in [the issue tracker of this repository](https://github.com/arduino/library-registry/issues), specifying the URL of the library repository and requesting that the library be updated. Once you have done that, open an issue in [the issue tracker of this repository](https://github.com/arduino/library-registry/issues), specifying the URL of the library repository and requesting that the library be updated.
### How can I change a library's name?
<a id="how-can-i-change-my-librarys-name"></a> <a id="how-can-i-change-my-librarys-name"></a>
### How can I change a library's name?
For the sake of continuity, libraries in the Library Manager list are locked to the name they had at the time they were added to the list. Changing the library name can be disruptive to its users because this is the unique identifier for the library used by the Arduino development software [command line interfaces](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_lib/), sketch [metadata](https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata), library [dependencies](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format), and installation location. For the sake of continuity, libraries in the Library Manager list are locked to the name they had at the time they were added to the list. Changing the library name can be disruptive to its users because this is the unique identifier for the library used by the Arduino development software [command line interfaces](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_lib/), sketch [metadata](https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata), library [dependencies](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format), and installation location.
If you wish to change the name it will need to be done manually by request: If you wish to change the name it will need to be done manually by request: