From fd69d52f3af1e7df8842efb1a2de10d72285d42a Mon Sep 17 00:00:00 2001 From: David Madison Date: Wed, 9 Nov 2022 17:36:26 -0500 Subject: [PATCH 1/4] Rearranged README --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index cbbe30c..158ea16 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,10 @@ -# SparkFun Arduino Boards w/ XInput [![Build Status](https://github.com/dmadison/ArduinoXInput_Sparkfun/workflows/build/badge.svg?branch=master)](https://github.com/dmadison/ArduinoXInput_Sparkfun/actions?query=workflow%3Abuild) +# SparkFun Arduino Boards w/ XInput +[![Build Status](https://github.com/dmadison/ArduinoXInput_Sparkfun/workflows/build/badge.svg?branch=master)](https://github.com/dmadison/ArduinoXInput_Sparkfun/actions?query=workflow%3Abuild) -This repository contains support for the following SparkFun Arduino-compatible development boards, modified to work as XInput devices. Originally forked from [the SparkFun repo](https://github.com/sparkfun/Arduino_Boards). +This repository contains support for the SparkFun Arduino-compatible development boards, modified to work as XInput devices. Originally forked from [the SparkFun repo](https://github.com/sparkfun/Arduino_Boards). These boards are meant to be used in conjunction with the [ArduinoXInput library](https://github.com/dmadison/ArduinoXInput). -## Included Boards - -* [MaKey MaKey](https://www.sparkfun.com/products/11511) -* [Pro Micro 3.3V](https://www.sparkfun.com/products/10999) -* [Pro Micro 5V](https://www.sparkfun.com/products/11098) -* [Fio v3](https://www.sparkfun.com/products/11520) -* [Qduino Mini](https://www.sparkfun.com/products/13614) -* [LilyPad USB Plus](https://www.sparkfun.com/products/14346) - ## Installation 
 └───Arduino Installation
@@ -46,10 +38,17 @@ To uninstall, delete the 'xinput_sparkfun' folder in the 'hardware' directory, a
 
 ## 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.
 
 [Full instructions for uploading are provided in the AVR Core repository](https://github.com/dmadison/ArduinoXInput_AVR/#upload-warning-and-instructions).
 
-**Do *not* upload XInput sketches to your Arduino unless you know how to reset it!** Otherwise you will not be able to program it anymore and you'll have to [reflash the bootloader](https://learn.sparkfun.com/tutorials/installing-an-arduino-bootloader/all) with an external programmer.
+**Do *not* upload XInput sketches to your Arduino unless you know how to reset it!** Otherwise you will not be able to program it anymore and you'll have to remove the XInput sketch by flashing the board with an external programmer.
+
+## Included Boards
+
+* [MaKey MaKey](https://www.sparkfun.com/products/11511)
+* [Pro Micro 3.3V](https://www.sparkfun.com/products/10999)
+* [Pro Micro 5V](https://www.sparkfun.com/products/11098)
+* [Fio v3](https://www.sparkfun.com/products/11520)
+* [Qduino Mini](https://www.sparkfun.com/products/13614)
+* [LilyPad USB Plus](https://www.sparkfun.com/products/14346)

From 53e72f016d72992a8eed221485195f13ab92879e Mon Sep 17 00:00:00 2001
From: David Madison 
Date: Wed, 9 Nov 2022 17:43:14 -0500
Subject: [PATCH 2/4] Add 'AVR only' note to README

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index 158ea16..5521ebb 100644
--- a/README.md
+++ b/README.md
@@ -46,9 +46,13 @@ Due to the nature of how the XInput USB mode works, Arduinos that have XInput sk
 
 ## Included Boards
 
+All of the following boards make use of the [Arduino XInput AVR core](https://github.com/dmadison/ArduinoXInput_AVR):
+
 * [MaKey MaKey](https://www.sparkfun.com/products/11511)
 * [Pro Micro 3.3V](https://www.sparkfun.com/products/10999)
 * [Pro Micro 5V](https://www.sparkfun.com/products/11098)
 * [Fio v3](https://www.sparkfun.com/products/11520)
 * [Qduino Mini](https://www.sparkfun.com/products/13614)
 * [LilyPad USB Plus](https://www.sparkfun.com/products/14346)
+
+Other SparkFun boards may be theoretically compatible with XInput, but are not yet available because the XInput USB modifications have not been ported to their architecture.

From e78459a4b898a355932102dc4691b4c3f09e5e1f Mon Sep 17 00:00:00 2001
From: David Madison 
Date: Wed, 9 Nov 2022 17:54:30 -0500
Subject: [PATCH 3/4] Add automated installation instructions

---
 README.md | 56 +++++++++++++++++++++++++++++++------------------------
 1 file changed, 32 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 5521ebb..c1d8b67 100644
--- a/README.md
+++ b/README.md
@@ -5,36 +5,44 @@ This repository contains support for the SparkFun Arduino-compatible development
 
 These boards are meant to be used in conjunction with the [ArduinoXInput library](https://github.com/dmadison/ArduinoXInput).
 
-## Installation
+## Automated Installation
+
+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).
+
+Add the following line to the "Additional Boards Manager URLs" list:
+```
+https://raw.githubusercontent.com/dmadison/ArduinoXInput_Boards/master/package_dmadison_xinput_index.json
+```
+
+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.
+
+## Manual Installation
 
-└───Arduino Installation
-	├───drivers
-	├───examples
-	├───hardware
-	│   ├───arduino
-	│   ├───tools
-	│   ├───xinput
-	│   └───xinput_sparkfun
-	│       └───avr
-	│           ├───bootloaders
-	│           ├───cores
-	│           ├───libraries
-	│           └───variants
-	├───java
-	├───lib
-	├───libraries
-	├───reference
-	├───tools
-	└───tools-builder
+└───Arduino App Data Folder
+    ├───cache
+    ├───logs
+    ├───staging
+    └───packages
+        ├───arduino
+        └───xinput
+        └───xinput_sparkfun
+            └───hardware
+                └───avr
+                    └───{version}
+                        ├───bootloaders
+                        ├───libraries
+                        └───variants
 

 
-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.
+To install manually you will need to find the Arduino IDE's application data folder. On Windows this is located in `%APPDATA%\..\Local\Arduino15`.
+
+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.
 
-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).
+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.
 
-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.
+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.
 
-To uninstall, delete the 'xinput_sparkfun' folder in the 'hardware' directory, and then restart the Arduino IDE.
+To uninstall, delete both "xinput" folders and then restart the Arduino IDE.
 
 ## Upload Warning and Instructions
 

From 37d4446cb2371a0842ea4b4d386b72ebd58292b2 Mon Sep 17 00:00:00 2001
From: David Madison 
Date: Wed, 9 Nov 2022 17:55:32 -0500
Subject: [PATCH 4/4] Update CI versions

---
 .github/workflows/ci.yml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index caa47ec..cb98e93 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -3,7 +3,7 @@ name: build
 on: [push, pull_request, workflow_dispatch]
 
 env:
-  IDE_VERSION: 1.8.13
+  IDE_VERSION: 1.8.19
   IDE_LOCATION: /usr/local/share/arduino
 
 jobs:
@@ -23,7 +23,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install Arduino IDE
         run: |