Move example sketch to appropriately named folder #8
Conversation
This file contains hidden or 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
This change causes the example sketch to be accessible via the Arduino IDE's File > Examples > Arduino_LCD_Menu 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This change causes the example sketch to be accessible via the Arduino IDE's File > Examples > Arduino_LCD_Menu 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
This PR proposes a subset of the changes previously proposed in #2. Since that pull request has not been merged after years, it's hoped that maybe a less extensive change would be accepted.