Skip to content

Structure library for improved Arduino compatibility #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Structure library for improved Arduino compatibility #1

wants to merge 2 commits into from

Conversation

per1234
Copy link

@per1234 per1234 commented May 25, 2019

  • Move library to root of repository
  • Move example sketch to examples folder

per1234 added 2 commits May 25, 2019 02:01
@per1234
Move library to root of repository
9648379 
A popular library installation technique is to download the .zip files of the library GitHub generates (Clone or download > Download ZIP or the Releases page) 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.
@per1234
Move example sketch to examples folder
d387b61 
The Arduino Library specification says that example sketches should be stored under the examples folder.

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
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@per1234