Pio arduino library compliance #11
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PR moves files and adds the required properties files to make the library compliant with Arduino and PlatformIO library managers. After the PR the code can be submitted by following these guides:
Arduino:
https://github.com/arduino/library-registry?tab=readme-ov-file#adding-a-library-to-library-manager
A command exists to verify compliance and the library passes it. There is a warning caused by the absence of a license file. I'm not sure if the library was ever under any license, personally I would vote to use MIT. Please do not use GPLv3 since it means the library won't be able to be used for non-GPL projects.
PlatformIO:
https://docs.platformio.org/en/latest/librarymanager/creating.html#publishing
No command exists to verify compliance, but hopefully I added all the required fields.
@thorsten-gehrig if you don't see any of the options I chose (e.g. version 0.1.0) to be fit for the library feel free to change them.