Skip to content

Conversation

@MHeironimus
Copy link
Owner

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/libraries folder. See the updated README for more details.

Includes PRs

MHeironimus and others added 13 commits February 20, 2018 18:41
Update version-2.0 branch with latest changes from master
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.
…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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants