Firmware for the Keyboardio Model 01 and other keyboards with AVR or ARM MCUs.
 
 
 
 
 
 
Go to file
Jesse Vincent 8c6b8433cc
astyle pass
8 years ago
doc Revert "switch from one space indent to two space indent before public: and private:" 8 years ago
etc rename our udev rules file 8 years ago
examples astyle pass 8 years ago
src astyle pass 8 years ago
tools Switch up the -libraries order so the local version of a library gets 8 years ago
.gitignore Add a gitignore file 8 years ago
.kaleidoscope-builder.conf Remove the hook for the now-removed layout transformation script 8 years ago
.travis.yml Attempt to switch to shared build infrastructure for build and test. 8 years ago
CODE_OF_CONDUCT.md Code of conduct 8 years ago
LICENSE Update the text of the GPL-2 to the latest text 8 years ago
Makefile Attempt to switch to shared build infrastructure for build and test. 8 years ago
README.md README updates 8 years ago
library.properties The Big Rename 8 years ago

README.md

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.

Install the Kaleidoscope Hardware Definitions

# 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

# 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/kaleidoscope
ln -s $HOME/kaleidoscope/Arduino-Boards $SKETCHBOOK_DIR/hardware/kaleidoscope/avr

Clone and Build the Kaleidoscope Firmware

# go to your keyboardio directory
cd $HOME/kaleidoscope
# then clone the firmware repository
git clone https://github.com/keyboardio/Kaleidoscope.git
# and build your firmware!
cd Kaleidoscope
make

<3 jesse

BuildStatus