Improve Compatibility with the Arduino IDE #1
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
per1234
commented
Jul 10, 2018
per1234
commented
- Move library to root of repository for easier installation.
- Move example sketch to appropriately named folder to make it accessible via the File > Examples menu.
A popular library installation technique is to download the library via GitHub's Clone or download > Download ZIP and then use the Arduino IDE's Sketch > Include Library > Add .ZIP Library on the downloaded file. This requires the library to be in the root of the repository, not in a subfolder. If the library is not in the root of the repository this installation technique fails: Specified folder/zip file does not contain a valid library This is the standard repository structure used in all official Arduino libraries: https://github.com/arduino-libraries This move is also required if you wanted to add your library to the Arduino Library Manager index, which provides an even easier installation option.
This change causes the example sketch to be accessible via the Arduino IDE's File > Examples > RF_Transmit menu after the library is installed. Reference: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#library-examples
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.