aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Madison <dmadison@users.noreply.github.com>2019-03-06 21:36:12 -0500
committerGitHub <noreply@github.com>2019-03-06 21:36:12 -0500
commit8d86efe5d822643fc09eac486d331f2723df4ad5 (patch)
treee4cd113645271937364619ce3d3bd3c37ced7931 /README.md
parentdbdc21467c53132fae4d811784476e02d5ce0309 (diff)
Add Installation section to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index cc6b962..424110c 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,35 @@
# XInput USB Core for Arduino AVR
The files in this repository allow you to emulate an Xbox gamepad (XInput) using a USB-capable Arduino microcontroller.
-
+
+## Installation
+<pre>
+└───Arduino Installation
+ ├───drivers
+ ├───examples
+ ├───hardware
+ │ ├───arduino
+ │ ├───tools
+ │ └───<b>xinput
+ │ └───avr
+ │ ├───bootloaders
+ │ ├───cores
+ │ ├───libraries
+ │ └───variants</b>
+ ├───java
+ ├───lib
+ ├───libraries
+ ├───reference
+ ├───tools
+ └───tools-builder
+</pre>
+
+To install, 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' folder with an 'avr' folder inside of it, containing the files from this repository (see the tree view above).
+
+Restart the Arduino IDE. If the XInput AVR core is installed correctly, you should see a new collection of "XInput AVR Boards" in the `Tools -> Boards` menu.
+
+To uninstall, delete the 'xinput' folder in the 'hardware' directory, and then restart the Arduino IDE.
+
## Supported Boards
* [Adafruit Circuit Playground 32u4](https://www.adafruit.com/product/3000)