Skip to content

Commit 0c6336e

Browse files
committed
Move library to root of repository
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.
1 parent 3686123 commit 0c6336e

File tree

16 files changed

+2
-13
lines changed

16 files changed

+2
-13
lines changed

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,8 @@ The joystick or gamepad can have the following features:
1515
- Steering (up to 16-bit precision)
1616

1717
## Installation Instructions
18-
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.
19-
### Microsoft Windows
20-
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).
21-
### Linux
22-
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.]
18+
1. Download https://github.com/MHeironimus/ArduinoJoystickLibrary/archive/master.zip
19+
2. (In the Arduino IDE) Sketch > Include Library > Add .ZIP Library... > select the downloaded file > Open. The Joystick library's examples will now appear under File > Examples > Joystick.
2320

2421
## Examples
2522
The following example Arduino sketch files are included in this library:

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)