search

UMDBPP / Balloonduino

Library for basic functions of Balloonduino (Arduino Mega with onboard sensors)
MIT License
3 stars 0 forks source link

Move example sketch to examples folder #29

Closed per1234 closed 5 years ago

per1234 commented 5 years ago

This change causes the example sketch to be accessible via the Arduino IDE's File > Examples > LIBRARYNAME menu after the library is installed.

The Arduino IDE does recognize example sketches in the root of the library folder when their filename matches the folder name and this example filename does match the repository name. However, GitHub names the folder in the .zip file attained via Clone or Download > Download ZIP by appending the branch name to the repository name so this causes a name mismatch and the example sketch to not be recognized in its previous location.

The Arduino Library specification says that examples sketches should be stored under the examples folder so there is no guarantee that example sketches stored outside of that location will continue to be recognized

Reference: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#library-examples

zacharyburnett commented 5 years ago

Thank you for the information. Active development on the Balloonduino library is currently on hold as we iron out some bugs with the hardware and possibly change the sensors, but your contribution is still very much appreciated.