@ -8,8 +8,6 @@ If you're just getting started with the Keyboardio Model 01, the [introductory d
# Getting Started
# 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
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.
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.
@ -17,32 +15,49 @@ Setup the Arduino IDE on your system. Make sure you install at least version 1.6
* On Linux, follow the instructions [on the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Install-Arduino-support-on-Linux).
* On Linux, follow the instructions [on the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Install-Arduino-support-on-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.
* 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
## Get into the right directory
### macOS
```sh
mkdir -p $HOME/Documents/Arduino/hardware
cd $HOME/Documents/Arduino/hardware
```
### Linux
```sh
```sh
# you'll need to know your arduino sketchbook directory
mkdir -p $HOME/Arduino/hardware
cd $HOME/Arduino/hardware
```
### Windows
# on macOS the default is
*TODO*: Write me
SKETCHBOOK_DIR=$HOME/Documents/Arduino
# on Linux the default is
### Install the libraries and hardware definitions