Skip to content

Commit 7642973

Browse files
authored
Add installation instructions to README
1 parent 9dbb182 commit 7642973

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,42 @@ This repository contains support for the following SparkFun Arduino-compatible d
44

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

7-
#### AVR Boards
7+
## Included Boards
88

99
* [MaKey MaKey](https://www.sparkfun.com/products/11511)
1010
* [Pro Micro 3.3V](https://www.sparkfun.com/products/10999)
1111
* [Pro Micro 5V](https://www.sparkfun.com/products/11098)
1212
* [Fio v3](https://www.sparkfun.com/products/11520)
1313
* [Qduino Mini](https://www.sparkfun.com/products/13614)
1414
* [LilyPad USB Plus](https://www.sparkfun.com/products/14346)
15+
16+
## Installation
17+
<pre>
18+
└───Arduino Installation
19+
├───drivers
20+
├───examples
21+
├───hardware
22+
│ ├───arduino
23+
│ ├───tools
24+
│ ├───<b>xinput</b>
25+
│ └───<b>xinput_sparkfun
26+
│ └───avr
27+
│ ├───bootloaders
28+
│ ├───cores
29+
│ ├───libraries
30+
│ └───variants</b>
31+
├───java
32+
├───lib
33+
├───libraries
34+
├───reference
35+
├───tools
36+
└───tools-builder
37+
</pre>
38+
39+
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.
40+
41+
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).
42+
43+
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.
44+
45+
To uninstall, delete the 'xinput_sparkfun' folder in the 'hardware' directory, and then restart the Arduino IDE.

0 commit comments

Comments
 (0)