diff options
| author | Jesse Vincent <jesse@keyboard.io> | 2017-08-04 17:19:51 +0900 |
|---|---|---|
| committer | Jesse Vincent <jesse@keyboard.io> | 2017-08-16 13:26:55 -0700 |
| commit | 205c41cacec98f188eceb116c85aa96628d8b464 (patch) | |
| tree | 6a39b8f950591686f0cbd286a912756dcebc8bc6 /README.md | |
| parent | astyle (diff) | |
| download | keyboardio-model01-205c41cacec98f188eceb116c85aa96628d8b464.tar.gz keyboardio-model01-205c41cacec98f188eceb116c85aa96628d8b464.tar.bz2 keyboardio-model01-205c41cacec98f188eceb116c85aa96628d8b464.zip | |
A pass at cleaning up the install instructions and Makefile a bit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 8 insertions, 16 deletions
@@ -10,38 +10,30 @@ Pick a directory to work in, you'll need to clone multiple repositories. We'll a 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 Linux, follow 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 * 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 -# you'll need to know your arduino sketchbook directory +# 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 -# make a directory for kaleidoscope, the Model 01 firmware -mkdir $HOME/kaleidoscope - -# go to your kaleidoscope directory -cd $HOME/kaleidoscope - -# then clone the hardware definitions -git clone --recursive https://github.com/keyboardio/Arduino-Boards.git - -# and make them available to the arduino environment +# Make a directory for the Arduino sketchbook and our hardware definitions mkdir -p $SKETCHBOOK_DIR/hardware/keyboardio -ln -s $HOME/kaleidoscope/Arduino-Boards $SKETCHBOOK_DIR/hardware/keyboardio/avr -``` + +# then clone the hardware definitions to make them available to the arduino environment +git clone --recursive https://github.com/keyboardio/Arduino-Boards.git $SKETCHBOOK_DIR/hardware/keyboardio/avr ## Clone and Build the Kaleidoscope Firmware for the Model 01 ```sh -# go to your keyboardio directory -cd $HOME/kaleidoscope +# go to your Arduino sketchbook +cd $SKETCHBOOK # then clone the firmware repository git clone https://github.com/keyboardio/Model01-Firmware.git |