Skip to content

Move example sketch to appropriately named folder#1

Open
per1234 wants to merge 1 commit into
cbmeeks:masterfrom
per1234:example-folder
Open

Move example sketch to appropriately named folder#1
per1234 wants to merge 1 commit into
cbmeeks:masterfrom
per1234:example-folder

Conversation

@per1234
Copy link
Copy Markdown

@per1234 per1234 commented May 29, 2019

The Arduino IDE requires the sketch folder name to match the filename of the primary sketch file. This change causes the example sketch to be accessible via the Arduino IDE's File > Examples > SoundBoard menu after the library is installed.

Having a sketch outside the examples folder causes the Arduino Web Editor to recognize the imported library as a sketch instead of a library, making it so you can't use it as a library.

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

The Arduino IDE requires the sketch folder name to match the filename of the primary sketch file. This change causes the example sketch to be accessible via the Arduino IDE's File > Examples > SoundBoard menu after the library is installed.

Having a sketch outside the examples folder causes the Arduino Web Editor to recognize the imported library as a sketch instead of a library, making it so you can't use it as a library.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant