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

A pass at cleaning up the install instructions and Makefile a bit

Browse Source
This commit is contained in:
Jesse Vincent 2017-08-04 17:19:51 +09:00
parent 747d42dc92
commit 205c41cace
No known key found for this signature in database
GPG Key ID: 122F5DF7108E4046
2 changed files with 11 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Makefile
View File

@ -5,9 +5,10 @@ MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build
UNAME_S := $(shell uname -s) UNAME_S := $(shell uname -s)
ifeq ($(UNAME_S),Darwin) ifeq ($(UNAME_S),Darwin)
BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/
else else
BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware SKETCHBOOK_DIR ?= $(HOME)/arduino
endif endif
BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware
include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk

24
README.md
View File

@ -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. 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. * 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 ## Install the Kaleidoscope Hardware Definitions
```sh ```sh
# you'll need to know your arduino sketchbook directory # You'll need to know your arduino sketchbook directory
# on macOS the default is # on macOS the default is
SKETCHBOOK_DIR=$HOME/Documents/Arduino SKETCHBOOK_DIR=$HOME/Documents/Arduino
# on Linux the default is # on Linux the default is
SKETCHBOOK_DIR=$HOME/Arduino SKETCHBOOK_DIR=$HOME/Arduino
# make a directory for kaleidoscope, the Model 01 firmware # Make a directory for the Arduino sketchbook and our hardware definitions
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
mkdir -p $SKETCHBOOK_DIR/hardware/keyboardio 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 ## Clone and Build the Kaleidoscope Firmware for the Model 01
```sh ```sh
# go to your keyboardio directory # go to your Arduino sketchbook
cd $HOME/kaleidoscope cd $SKETCHBOOK
# then clone the firmware repository # then clone the firmware repository
git clone https://github.com/keyboardio/Model01-Firmware.git git clone https://github.com/keyboardio/Model01-Firmware.git