# Kaleidoscope
Flexible firmware for Arduino-powered keyboards
# 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.
## Setup 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.
## Install the Kaleidoscope Hardware Definitions
```sh
SKETCHBOOK_DIR=$HOME/Documents/Arduino
SKETCHBOOK_DIR=$HOME/Arduino
mkdir $HOME/kaleidoscope
cd $HOME/kaleidoscope
git clone --recursive https://github.com/keyboardio/Arduino-Boards.git
mkdir -p $SKETCHBOOK_DIR/hardware/keyboardio
ln -s $HOME/kaleidoscope/Arduino-Boards $SKETCHBOOK_DIR/hardware/keyboardio/avr
```
## Clone and Build the Kaleidoscope Firmware for the Model 01
```sh
cd $HOME/kaleidoscope
git clone https://github.com/keyboardio/Model01-Firmware.git
cd Model01-Firmware
make flash
```
<3 jesse
[![Build Status](https://travis-ci.org/keyboardio/Model01-Firmware.svg?branch=master)](https://travis-ci.org/keyboardio/Model01-Firmware)