From f27ca2033273f12cc3ed7479208e2732459150ce Mon Sep 17 00:00:00 2001 From: Spacehuhn Date: Wed, 16 Nov 2022 15:51:24 +0100 Subject: [PATCH] Readme update --- README.md | 28 +++++++++++++++++----------- sketch.yaml | 10 ---------- 2 files changed, 17 insertions(+), 21 deletions(-) delete mode 100644 sketch.yaml diff --git a/README.md b/README.md index f5828f2..f1c39d9 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ # USBNova -## Arduino-CLI -* Install it (Download it and add it to PATH) -* Initiate it `arduino-cli config init` (it is saved at `C:\Users\username\AppData\Local\Arduino15\arduino-cli.yaml`) -* Update cores `arduino-cli core update-index` -* Install core `arduino-cli core install adafruit:samd` -* Check your boards `arduino-cli board list` -* Compile `arduino-cli compile --profile adafruit_qtpy_m0` -* Upload `arduino-cli upload -p COM3` -* Compile and upload `arduino-cli compile --fqbn adafruit:samd:adafruit_qtpy_m0:opt=small,usbstack=tinyusb,debug=off -u -p COM3` -* Compile export `arduino-cli compile --fqbn adafruit:samd:adafruit_qtpy_m0:opt=small,usbstack=tinyusb,debug=off --output-dir build/` -* Convert to uf2 `uf2conv build/USBNova.ino.bin -o build/USBNova.ino.uf2` \ No newline at end of file +Source code of the USB Nova firmware. + +For documentation, please visit: [usbnova.com](https://usbnova.com/) + +## Compile using Arduino-CLI +Install [Arduino-CLI](https://arduino.github.io/arduino-cli/0.28/installation/). +Add `https://adafruit.github.io/arduino-board-index/package_adafruit_index.json` to the additional board manager URLs. +Edit boards.txt in `/packages/adafruit/hardware/samd//` and add [boards.txt](boards.txt). + +Compile and upload: +`arduino-cli compile --fqbn adafruit:samd:adafruit_qtpy_m0_nova:usbstack=tinyusb,debug=off -u -p ` + +Compile and export: +`arduino-cli compile --fqbn adafruit:samd:adafruit_qtpy_m0_nova:usbstack=tinyusb,debug=off --output-dir build/` + +Convert to uf2: +`uf2conv build/USBNova.ino.bin -o build/USBNova.ino.uf2` \ No newline at end of file diff --git a/sketch.yaml b/sketch.yaml deleted file mode 100644 index 8c98fe8..0000000 --- a/sketch.yaml +++ /dev/null @@ -1,10 +0,0 @@ -profile: - adafruit_qtpy_m0: - fqbn: adafruit:samd:adafruit_qtpy_m0:opt=small,usbstack=tinyusb,debug=off - platforms: - - platform: adafruit:samd (1.7.10) - platform_index_url: https://adafruit.github.io/arduino-board-index/package_adafruit_index.json - libraries: - - SdFat_-_Adafruit_Fork (1.2.4) - - Adafruit_NeoPixel (1.10.0) - - Adafruit_SPIFlash (3.7.1) \ No newline at end of file