diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 74 |
1 files changed, 42 insertions, 32 deletions
@@ -1,60 +1,70 @@ -# Kaleidoscope +# Keyboardio Model 01 Firmware -Flexible firmware for Arduino-powered keyboards +The default firmware for the Keyboardio Model 01 -# Getting Started -Pick a directory to work in, you'll need to clone multiple repositories. We'll assume you picked `$HOME/kaleidoscope`, if you chose another adapt the commands below accordingly. +# Download and install -## Setup the Arduino IDE +## 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. -* On Linux, follow the instructions [on the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Arduino-Setup-Linux). -* On macOS, install 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. +### macOS -## Install the Kaleidoscope Hardware Definitions +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. -```sh -# you'll need to know your arduino sketchbook directory -# on macOS the default is -SKETCHBOOK_DIR=$HOME/Documents/Arduino -# on Linux the default is -SKETCHBOOK_DIR=$HOME/Arduino +### 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). + +If you install Arduino into some place that's /not/ `/usr/local/arduino`, you'll need to set the `$ARDUINO_PATH` environment variable to the directory containing the `arduino` and `arduino-builder` binaries. -# make a directory for kaleidoscope, the Model 01 firmware -mkdir $HOME/kaleidoscope +## Create and navigate to the Arduino Sketchbook directory -# go to your kaleidoscope directory -cd $HOME/kaleidoscope +### MacOS +```sh +mkdir -p $HOME/Documents/Arduino +cd $HOME/Documents/Arduino +``` -# then clone the hardware definitions -git clone --recursive https://github.com/keyboardio/Arduino-Boards.git +### Linux -# and make them available to the arduino environment -mkdir -p $SKETCHBOOK_DIR/hardware/keyboardio -ln -s $HOME/kaleidoscope/Arduino-Boards $SKETCHBOOK_DIR/hardware/keyboardio/avr +```sh +mkdir -p $HOME/Arduino +cd $HOME/Arduino ``` -## Clone and Build the Kaleidoscope Firmware for the Model 01 +## Download hardware platform, including library source code ```sh -# go to your keyboardio directory -cd $HOME/kaleidoscope +mkdir -p hardware/keyboardio + +## 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 +## Download the Model 01 Firmware + +```sh git clone https://github.com/keyboardio/Model01-Firmware.git +``` -# and build your firmware! -cd Model01-Firmware +# Build and flash the firmware from the commandline +```sh +cd Model01-Firmware make flash - -# When the builder tells you to hit return to continue, -# hold down "prog" on your keyboard and hit return. ``` +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) |