Community Updates 1 #151
Merged
Community Updates 1 #151
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
* Created initial issue template file * Created initial pull request template
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. 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 move is also required if you wanted to add your library to the Arduino Library Manager index, which provides an even easier installation option. After this change, the installation scripts are no longer needed. These scripts would only work with the default sketchbook location.
* Update to use new GitHub templates * Deleting old template files.
…rduinoJoystickLibrary into community-updates Including DynamicHID.h in Joystick.h using <> prevents it from being found if the library is not in the Arduino/libraries directory. This means that it cannot be included as part of a project and significantly increases the difficulty of using it as a git submodule where the library cannot easily be patched. Using "" should not break anything if it is installed to Arduino/libraries. This PR simply changes the include to "".
- Reformatted README - Use syntax highlighting for code example - Fixed typo
…duinoJoystickLibrary into community-updates 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. 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 move is also required if you wanted to add your library to the [Arduino Library Manager](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ) index, which provides an even easier installation option. After this change, the installation scripts are no longer needed. These scripts would only work with the default sketchbook location.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 update contains changes contributed by @per1234 and @e-bonner. These update allow the library to be installed via a GitHub download or to function properly even if it is not installed in the
Arduino/librariesfolder. See the updated README for more details.Includes PRs