arduino/library-registry
1
0
Fork 0
mirror of https://github.com/arduino/library-registry.git synced 2025-12-03 14:51:16 +03:00
Code Activity

Update links to point to new locations

Browse Source 
Even though redirects have been set up for the previous URLs, it seems safest to not rely on them.
This commit is contained in:
per1234
2021-05-25 07:18:23 -07:00
parent bc1ae9e407
commit 59d98edb01
2 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
FAQ.md
View File

@@ -79,7 +79,7 @@ Follow the instructions [here](README.md#adding-a-library-to-library-manager).
- [ ] The library repository must not contain a [`.development` file](https://arduino.github.io/arduino-cli/latest/library-specification/#development-flag-file).
- [ ] The library repository must not contain any [symlinks](https://en.wikipedia.org/wiki/Symbolic_link).
- [ ] The library repository must not contain any files detected as infected by our antivirus scan.
- [ ] The library repository must have a [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) (or [release](https://help.github.com/articles/creating-releases/)) and must have been compliant with all the above requirements at the time of that tag.
- [ ] The library repository must have a [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) (or [release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository)) and must have been compliant with all the above requirements at the time of that tag.
- [ ] The library repository must be hosted on a major Git-hosting website like GitHub, BitBucket or GitLab (other hosting sites may be considered on request).
Arduino has created a command line tool to check libraries for compliance with all the Library Manager requirements:
@@ -102,7 +102,7 @@ Note that libraries will need to be compliant with [all requirements](#update-re
1. Make sure the library is compliant with [all requirements](#update-requirements).
1. Update the `version` in the library's [`library.properties`](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata)).
1. Tag the library's repository once more and push the new tag (or create a release if the library's Git-hosting site offers a way to do it, for example with [GitHub "releases"](https://help.github.com/articles/creating-releases/)).
1. Tag the library's repository once more and push the new tag (or create a release if the library's Git-hosting site offers a way to do it, for example with [GitHub "releases"](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository)).
[Our indexer](#how-is-the-library-manager-index-generated) checks for new releases every hour and will eventually fetch and publish the new release.

17
README.md
View File

@@ -25,8 +25,8 @@ For more information about Arduino Library Manager and how the index is maintain
## 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](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) that
adds the repository URL to [the list](repositories.txt). You are welcome to add multiple libraries at once.
[pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)
that adds the repository URL to [the list](repositories.txt). 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.
@@ -54,8 +54,8 @@ with your pull request or with the library.
#### If the problem is with the pull request:
Edit the file in the
[branch](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches) you submitted the
pull request from in your fork of the `arduino/library-registry` repository, then commit.
[branch](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)
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.
@@ -64,10 +64,11 @@ Doing this will update the pull request and cause the automated checks to run ag
1. Make the necessary fix in the library repository.
1. Increment the `version` value in the library's
[library.properties file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata).
1. Create a [release](https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) or
[tag](https://git-scm.com/docs/git-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.
1. Create a
[release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository)
or [tag](https://git-scm.com/docs/git-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.
1. 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.