Skip to content

Commit e78459a

Browse files
committed
Add automated installation instructions
1 parent 53e72f0 commit e78459a

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

README.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,44 @@ This repository contains support for the SparkFun Arduino-compatible development
55

66
These boards are meant to be used in conjunction with the [ArduinoXInput library](https://github.com/dmadison/ArduinoXInput).
77

8-
## Installation
8+
## Automated Installation
9+
10+
Follow the official instructions for [adding third party boards](https://support.arduino.cc/hc/en-us/articles/360016466340-Add-or-remove-third-party-boards-in-Boards-Manager) and [adding boards to the Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016119519-Add-boards-to-Arduino-IDE).
11+
12+
Add the following line to the "Additional Boards Manager URLs" list:
13+
```
14+
https://raw.githubusercontent.com/dmadison/ArduinoXInput_Boards/master/package_dmadison_xinput_index.json
15+
```
16+
17+
If you've done this correctly, the XInput boards packages will be available within the Boards Manager. Install the "XInput AVR Boards" package as well as the "XInput SparkFun Boards" package. Note that the core "XInput AVR Boards" package is required for the SparkFun boards to work.
18+
19+
## Manual Installation
920
<pre>
10-
└───Arduino Installation
11-
├───drivers
12-
├───examples
13-
├───hardware
14-
│ ├───arduino
15-
│ ├───tools
16-
│ ├───<b>xinput</b>
17-
│ └───<b>xinput_sparkfun
18-
│ └───avr
19-
│ ├───bootloaders
20-
│ ├───cores
21-
│ ├───libraries
22-
│ └───variants</b>
23-
├───java
24-
├───lib
25-
├───libraries
26-
├───reference
27-
├───tools
28-
└───tools-builder
21+
└───Arduino App Data Folder
22+
├───cache
23+
├───logs
24+
├───staging
25+
└───packages
26+
├───arduino
27+
└───<b>xinput</b>
28+
└───<b>xinput_sparkfun
29+
└───hardware
30+
└───avr
31+
└───{version}
32+
├───bootloaders
33+
├───libraries
34+
└───variants</b>
2935
</pre>
3036

31-
To install, you first need to install the latest version of the Arduino XInput AVR Core, [which can be found here](https://github.com/dmadison/ArduinoXInput_AVR). Follow [the installation instructions](https://github.com/dmadison/ArduinoXInput_AVR/#installation) provided in that repository and verify that those boards are installed correctly before proceeding.
37+
To install manually you will need to find the Arduino IDE's application data folder. On Windows this is located in `%APPDATA%\..\Local\Arduino15`.
38+
39+
You will need to create the necessary folders in the "packages" directory: `xinput_sparkfun/hardware/avr/{version}`, where `{version}` is the current [semantic version number](https://en.wikipedia.org/wiki/Software_versioning) of the repository (e.g. "1.0.0"). The subfolder of this repository containing the boards files should then be copied into this folder. See the tree view above for reference.
3240

33-
This boards package uses the same process for installation. Download [the latest version](../../releases/latest) of this repository to your PC. Navigate to the directory containing your Arduino installation, and then open up the 'hardware' folder. Extract the contents of the .zip file into this directory. You should have a new 'xinput_sparkfun' folder with an 'avr' folder inside of it, containing the files from this repository (see the tree view above).
41+
You will also need to copy the boards files from the [Arduino XInput AVR core](https://github.com/dmadison/ArduinoXInput_AVR). Follow the instructions in the README. The two folders, `xinput` and `xinput_sparkfun`, should live next to each-other in the "packages" directory.
3442

35-
Restart the Arduino IDE. If the SparkFun boards are installed correctly, you should see a new collection of "SparkFun AVR Boards w/ XInput" in the `Tools -> Boards` menu.
43+
After you have copied the files, restart the Arduino IDE. If the SparkFun boards files are installed correctly, you should see a new collection of "SparkFun AVR Boards w/ XInput" in the `Tools -> Boards` menu. If you get an error while compiling, make sure the XInput AVR core is installed properly.
3644

37-
To uninstall, delete the 'xinput_sparkfun' folder in the 'hardware' directory, and then restart the Arduino IDE.
45+
To uninstall, delete both "xinput" folders and then restart the Arduino IDE.
3846

3947
## Upload Warning and Instructions
4048

0 commit comments

Comments
 (0)