Skip to content
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

Improve Compatibility with the Arduino IDE #1

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

Improve Compatibility with the Arduino IDE #1

wants to merge 2 commits into from

Commits on Jul 10, 2018

  1. Move library to root of repository 

    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.
    @per1234
    per1234 committed Jul 10, 2018
    Configuration menu
    Copy the full SHA
    6bfe4ca View commit details
    Browse the repository at this point in the history

  2. Move example sketch to appropriately named folder 

    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
    @per1234
    per1234 committed Jul 10, 2018
    Configuration menu
    Copy the full SHA
    f0e5131 View commit details
    Browse the repository at this point in the history