diff options
| author | Zach DeCook <zachdecook@librem.one> | 2023-05-28 09:54:14 -0400 |
|---|---|---|
| committer | Zach DeCook <zachdecook@librem.one> | 2023-05-29 20:30:49 -0400 |
| commit | 2a686a55c79b5db22a2227f5b0eac2f46ca7f7b4 (patch) | |
| tree | 9b29bc53db76f5076a1aa90404ec3d7256f7dbe4 /README.md | |
| parent | c9f4036651abbf3ceb75ba2d78a8411df07c6d6d (diff) | |
| download | HexBoard-2a686a55c79b5db22a2227f5b0eac2f46ca7f7b4.tar.gz | |
README: Add instructions for building with arduino-cli
and minor update to Makefile
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md index 3963062..4cb7b6a 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,32 @@ we'll assume you're already proficient at installing software on your computer a #### Using [arduino-cli](https://arduino.github.io/arduino-cli/latest/) -(Instructions to come) +(You also need to have `python3` installed on your system) + +```sh +# Download the board index +arduino-cli --additional-urls=https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json core update-index +# Install the core for rp2040 +arduino-cli --additional-urls=https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json core download rp2040:rp2040 +arduino-cli --additional-urls=https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json core install rp2040:rp2040 +# Install libraries +arduino-cli lib install "MIDI library" +arduino-cli lib install "Adafruit NeoPixel" +arduino-cli lib install "U8g2" # dependency for GEM +arduino-cli lib install "Adafruit GFX Library" # dependency for GEM +arduino-cli lib install "GEM" +sed -i 's@#include "config/enable-glcd.h"@//\0@g' ../libraries/GEM/src/config.h # remove dependency from GEM +# Correct Rotary Library +git clone https://github.com/buxtronix/arduino buxduino +cd buxduino +git apply ../Rotary.patch +cd .. +mv buxduino/libraries/Rotary ../libraries/ +rm -rf buxduino +# Run Make to build the firmware +make +``` +Your firmware file will be the uf2 file inside the build directory. ### Flashing the firmware |