Skip to content

Commit 16dbd07

Browse files
committed
Merge commit 'refs/pull/89/head' of https://github.com/MHeironimus/ArduinoJoystickLibrary 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.
2 parents d6f82a4 + 0c6336e commit 16dbd07

File tree

16 files changed

+3
-16
lines changed

16 files changed

+3
-16
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,10 @@ The joystick or gamepad can have the following features:
1919

2020
## Installation Instructions
2121

22-
Copy the `Joystick` folder to the Arduino libraries folder. Once the folder has been copied, the Joystick library should appear in the Arduino IDE list of libraries. The examples should also appear in the examples menu in the Arduino IDE.
22+
The following instructions can be used to install the latest version of the library in the Arduino IDE (thanks to [@per1234](https://github.com/per1234) for this update):
2323

24-
### Microsoft Windows
25-
26-
On Microsoft Windows machines, this is typically `%userprofile%\Documents\Arduino\libraries`. The `deploy.bat` file can be executed to install the Joystick folder on Microsoft Windows machines (assuming a default Arduino installation).
27-
28-
### Linux
29-
30-
On Linux machines, this is typically `$HOME/Arduino/libraries`. The `deploy.sh` file can be executed to install the Joystick folder on Linux machines (assuming a default Arduino installation). [Thanks to @Nihlus (Jarl Gullberg) for his help with this.]
24+
1. Download https://github.com/MHeironimus/ArduinoJoystickLibrary/archive/master.zip
25+
2. In the Arduino IDE, select `Sketch` > `Include Library` > `Add .ZIP Library...`. Browse to where the downloaded ZIP file is located and click `Open`. The Joystick library's examples will now appear under `File` > `Examples` > `Joystick`.
3126

3227
## Examples
3328

deploy.bat

Lines changed: 0 additions & 3 deletions
This file was deleted.

deploy.sh

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)