1
0
mirror of https://github.com/arduino/library-registry.git synced 2025-08-01 12:26:55 +03:00

Import Library Manager FAQ

An FAQ hosted in the `arduino/Arduino` repository's wiki:
https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ
has long served as the canonical guide for the traditional process for submitting libraries to the Library Manager index.

Now that the submission process and support for the process has been moved from `arduino/Arduino` to this dedicated
repository, it makes sense to also host the FAQ content here.

This commit imports the exact unmodified content of the FAQ from
819425389e
This commit is contained in:
per1234
2021-04-09 01:41:39 -07:00
parent f0f7dd1eb5
commit 9e9cabee69
2 changed files with 103 additions and 6 deletions

View File

@ -3,6 +3,10 @@
This repository contains the list of libraries in the
[Arduino Library Manager](https://www.arduino.cc/en/guide/libraries#toc3) index.
## Frequently asked questions
For more information about Arduino Library Manager and how the index is maintained, please see [the FAQ](FAQ.md).
## Adding a library to Library Manager
If you would like to have your library available for installation via Library Manager, just submit a
@ -14,8 +18,8 @@ See the instructions below for detailed instructions on how to do this via the G
### Instructions
1. You may want to first take a look at
[the requirements for admission into the Arduino Library Manager index](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ).
Each submission will be checked for compliance before being accepted.
[the requirements for admission into the Arduino Library Manager index](FAQ.md). Each submission will be checked for
compliance before being accepted.
1. Open this link to [fork](https://guides.github.com/activities/forking/) this repository and edit the list via the
GitHub web interface: https://github.com/arduino/library-registry/edit/main/repositories.txt
1. Add the library repository's URL to the list. This should be the URL of the repository home page. For example:
@ -70,10 +74,8 @@ description, making it clear that the URL is intentionally being removed.
## Report a problem with Library Manager
Please first take a look at
[the Arduino Library Manager FAQ](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ). If a library release is
missing from Library Manager, it is usually because it was not compliant with all the requirements listed in that
document.
Please first take a look at [the FAQ](FAQ.md). If a library release is missing from Library Manager, it is usually
because it was not compliant with all the requirements listed in that document.
This repository is not an appropriate place to request support or report problems with a library. Check the library's
own documentation for instructions or ask on the [Arduino Forum](https://forum.arduino.cc/).