aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Madison <dmadison@users.noreply.github.com>2019-03-06 22:01:35 -0500
committerGitHub <noreply@github.com>2019-03-06 22:01:35 -0500
commit4804dce9482cfb189e01710e44f78c71166d43ac (patch)
treeb48a6d7167349de0501f1fee1e70239f563c00c8
parent8d86efe5d822643fc09eac486d331f2723df4ad5 (diff)
Add auto-upload warning section to README
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 424110c..bb5fdb5 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,23 @@ Restart the Arduino IDE. If the XInput AVR core is installed correctly, you shou
To uninstall, delete the 'xinput' folder in the 'hardware' directory, and then restart the Arduino IDE.
+## Upload Warning and Instructions
+
+**!!!!!!! IMPORTANT !!!!!!!**
+
+Due to the nature of how the XInput USB mode works, Arduinos that have XInput sketches on them will ***not*** automatically reset when programmed by the IDE! You will need to reset the board by hand every time you upload new code.
+
+To upload to the board:
+* Connect the board via USB
+* Make sure the proper board is selected in the IDE
+* Hold the 'reset' button
+* Press 'Upload' in the IDE
+* Release the 'reset' button
+
+If you did these steps properly, the board should reset to the bootloader and the upload should begin. If your board does not have a 'reset' button, you can wire your own by connecting the 'reset' pin to ground.
+
+**Do *not* upload XInput sketches to your Arduino unless you know how to reset it!**
+
## Supported Boards
* [Adafruit Circuit Playground 32u4](https://www.adafruit.com/product/3000)