wxcafe/Model01-Firmware
1
0
Fork 0
Code Releases Activity

Reorganize makefile to avoid suggestions that Arduino lets you customize

Browse Source 
your sketchbook directory
This commit is contained in:
Jesse Vincent 2017-08-14 15:45:07 -07:00
parent 4b2be6fc2f
commit f5254600c6
No known key found for this signature in database
GPG Key ID: 122F5DF7108E4046
1 changed files with 31 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -2,52 +2,56 @@
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
# 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), 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.
# 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.
## 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
## MacOS
```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
# Make a directory for the Arduino sketchbook and our hardware definitions
mkdir -p $SKETCHBOOK_DIR/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 $SKETCHBOOK_DIR/hardware/keyboardio/avr
mkdir -p $HOME/Documents/Arduino
cd $HOME/Documents/Arduino
```
## Clone and Build the Kaleidoscope Firmware for the Model 01
## Linux
```sh
# go to your Arduino sketchbook
cd $SKETCHBOOK
mkdir -p $HOME/Arduino
cd $HOME/Arduino
```
# Download hardware platform, library source code and firmware source code
```sh
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
git clone https://github.com/keyboardio/Model01-Firmware.git
````
# and build your 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.
<3 jesse
[![Build Status](https://travis-ci.org/keyboardio/Model01-Firmware.svg?branch=master)](https://travis-ci.org/keyboardio/Model01-Firmware)