alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Firmware for the Keyboardio Model 01 and other keyboards with AVR or ARM MCUs.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
819 Commits
34 Branches
19 Tags
23 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ecc113ad7f'
${ noResults }
Go to file
Jesse Vincent ecc113ad7f
Added a note about how this isn't the right place to start for Model01 firmware 		7 years ago
doc Update function naming from CamelCase to camelCase, 7 years ago
etc rename our udev rules file 8 years ago
examples Update for changes to Kaleidoscope-Macros no longer requiring END 7 years ago
src make consumercontrol and systemcontrol events only fire on key release 7 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 Update Makefile to fix OS X build 7 years ago
README.md Added a note about how this isn't the right place to start for Model01 firmware 7 years ago
library.properties The Big Rename 8 years ago

README.md

Kaleidoscope

Flexible firmware for Arduino-powered keyboards.

This package contains the "core" of Kaleidoscope and an example firmware "Sketch." If you're looking for the firmware for the Keyboardio Model 01, you should start with https://github.com/keyboardio/Model01-Firmware

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