Skip to content

ChilleeeeZ/library-registry

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Arduino Library Manager list

This repository contains the list of libraries in the Arduino Library Manager index.

Table of Contents

Frequently asked questions

For more information about Arduino Library Manager and how the index is maintained, please see the FAQ.

Adding a library to Library Manager

If you would like to make a library available for installation via Library Manager, just submit a pull request that adds the repository URL to the list. You are welcome to add multiple libraries at once.

See the instructions below for detailed instructions on how to do this via the GitHub web interface.

Instructions

  1. You may want to first take a look at the requirements for admission into the Arduino Library Manager index. Each submission will be checked for compliance before being accepted.
  2. Open this link to fork this repository and edit the list via the GitHub web interface: https://github.com/arduino/library-registry/edit/main/repositories.txt
  3. Click the Fork this repository button.
  4. Add the library repository's URL to the list (it doesn't matter where in the list). This should be the URL of the repository home page. For example: https://github.com/arduino-libraries/Servo
  5. Click the Propose changes button.
  6. In the "Comparing changes" window that opens, click the Create pull request button.
  7. In the "Open a pull request" window that opens, click the Create pull request button.

The library will be automatically checked for compliance as soon as the pull request is submitted. If no problems were found, the pull request will be immediately merged and the library will be available for installation via Library Manager within a day's time.

If any problems are found, a bot will comment on the pull request to tell you what is wrong. The problem may be either with your pull request or with the library.

If the problem is with the pull request:

Edit the file in the branch you submitted the pull request from in your fork of the arduino/library-registry repository, then commit.

Doing this will update the pull request and cause the automated checks to run again.

If the problem is with the library:

  1. Make the necessary fix in the library repository.
  2. Increment the version value in the library's library.properties file.
  3. Create a release or tag. The Library Manager index always uses tagged versions of the libraries, so even if the development version of the library is compliant, it can't be accepted until the latest release or tag is compliant. Alternatively, you can redo the existing release/tag if you prefer.
  4. Comment on your pull request here in the arduino/library-registry repository, mentioning @ArduinoBot in the comment. Doing this will cause the automated check to run again.

Changing the URL of a library already in Library Manager

Submit a pull request that changes the URL as desired in repositories.txt. This can be done by following the instructions above.

Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull request description, making it clear that the URL is intentionally being changed.

Removing a library from Library Manager

Submit a pull request that removes the URL from repositories.txt. This can be done by following the instructions above.

Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull request description, making it clear that the URL is intentionally being removed.

Report a problem with Library Manager

First, please take a look at the 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.

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.

If the problem is about something else, please make an issue report here: https://github.com/arduino/library-registry/issues?q=is%3Aissue

About

Arduino Library Manager list

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published