Skip to content

Commit bfcf0d6

Browse files
committed
Added linux deployment script
1 parent d9c382d commit bfcf0d6

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Arduino Joystick Library
2-
#### Version 2.0.2
2+
#### Version 2.0.3
33
This library can be used with Arduino IDE 1.6.6 (or above) to add one or more joysticks (or gamepads) to the list of HID devices an [Arduino Leonardo](https://www.arduino.cc/en/Main/ArduinoBoardLeonardo) or [Arduino Micro](https://www.arduino.cc/en/Main/ArduinoBoardMicro) (or any Arduino clone that is based on the ATmega32u4) can support. This will not work with Arduino IDE 1.6.5 (or below) or with non-32u4 based Arduino devices (e.g. Arduino UNO, Arduino MEGA, etc.).
44

55
## Features
@@ -15,7 +15,11 @@ 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 (typically `%userprofile%\Documents\Arduino\libraries`). On Microsoft Windows machines, the `deploy.bat` file can be executed to install the Joystick folder (assuming a default Arduino installation). The library should now appear in the Arduino IDE list of libraries. The examples should also appear in the examples menu in the Arduino IDE.
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).
1923

2024
## Examples
2125
The following example Arduino sketch files are included in this library:
@@ -206,6 +210,7 @@ I have tested this library using the following Arduino IDE Versions:
206210
- 1.6.12
207211
- 1.6.13
208212
- 1.8.0
213+
- 1.8.1
209214

210215
I have tested this library with the following boards:
211216

@@ -221,4 +226,4 @@ works with the Arduino Due. I have also been told Version 1.x of the the Arduino
221226
- [Arduino UNO](https://www.arduino.cc/en/Main/ArduinoBoardUno) - NOT Supported - However, it might work with the [NicoHood/HoodLoader2](https://github.com/NicoHood/HoodLoader2) library, but I have not had a chance to try this out yet.
222227
- [Arduino MEGA](https://www.arduino.cc/en/Main/ArduinoBoardMega2560) - NOT Supported - However, it might work with the [NicoHood/HoodLoader2](https://github.com/NicoHood/HoodLoader2) library, but I have not had a chance to try this out yet.
223228

224-
(as of 2016-12-24)
229+
(as of 2017-01-14)

deploy.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env bash
2+
INSTALLPATH="$HOME/Arduino/libraries/Joystick"
3+
4+
rm -r -d "$INSTALLPATH"/*
5+
cp -r "Joystick" "$INSTALLPATH"

0 commit comments

Comments
 (0)