diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 24 insertions, 14 deletions
@@ -1,49 +1,54 @@ -# Kaleidoscope +# Keyboardio Model 01 Firmware -Flexible firmware for Arduino-powered keyboards +The default firmware for the Keyboardio Model 01 -# Set up the Arduino IDE +# Download and install + +## Set up the Arduino IDE Setup the Arduino IDE on your system. Make sure you install at least version 1.6, since older version may not support all required features. -# macOS +## macOS On macOS, install the Arduino IDE using [homebrew](http://brew.sh/) [cask](https://caskroom.github.io/) with `brew cask install arduino` or download the application from [the official website](https://www.arduino.cc/en/Main/Software) and move it to your `/Applications` folder. -## Linux +### Linux On Linux, your distribution's package manager probably includes the Arduino IDE, but it may be an out of date version. If your distribution installs a version of Arduino before 1.6.3 or so, you'll need to install the Arduino IDE following the instructions [on the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Arduino-Setup-Linux), installing the Arduino package somewhere that 'arduino' and 'arduino-builder' end up in your $PATH -# Create and navigate to the Arduino Sketchbook directory +## Create and navigate to the Arduino Sketchbook directory -## MacOS +### MacOS ```sh mkdir -p $HOME/Documents/Arduino cd $HOME/Documents/Arduino ``` -## Linux +### Linux ```sh mkdir -p $HOME/Arduino cd $HOME/Arduino ``` -# Download hardware platform, library source code and firmware source code +## Download hardware platform, including library source code ```sh mkdir -p hardware/keyboardio -# then clone the hardware definitions to make them available to the arduino environment +## then clone the hardware definitions to make them available to the arduino environment git clone --recursive https://github.com/keyboardio/Arduino-Boards.git hardware/keyboardio/avr - -# then clone the firmware repository -git clone https://github.com/keyboardio/Model01-Firmware.git ```` -# Build and flash the firmware from the commandline! +## Download the Model 01 Firmware + +```sh +git clone https://github.com/keyboardio/Model01-Firmware.git +``` + +# Build and flash the firmware from the commandline ```sh cd Model01-Firmware @@ -52,6 +57,11 @@ make flash When the builder tells you to hit Enter to continue, hold down "Prog" on your keyboard and hit Enter. + + + +# Thanks! + <3 jesse [](https://travis-ci.org/keyboardio/Model01-Firmware) |