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.
1115 Commits
34 Branches
19 Tags
23 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '38ccd717fd'
${ noResults }
Go to file
Jesse Vincent 38ccd717fd
Merge pull request #346 from keyboardio/h/use-error-fix 		7 years ago
bin Add double quotes to keep shellcheck happy 7 years ago
doc Merge pull request #322 from keyboardio/f/glossary 7 years ago
etc kaleidoscope-builder: Do not reset the device if NO_RESET is set 7 years ago
examples examples/AppSwitcher: Move the holding to loop() 7 years ago
src Fix the way we trigger an error on Kaleidoscope.use() with V2 API 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 Travis: ShellCheck kaleidoscope-builder 7 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 with OSX fixes and new paths 7 years ago
README.md Fix link 7 years ago
UPGRADING.md UPGRADING.md: Push out the v1 plugin API removal date 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 just getting started with the Keyboardio Model 01, the introductory docs are here and the source for the basic firmware package is here: https://github.com/keyboardio/Model01-Firmware. It's probably a good idea to start there, learn how to modify your keymap and maybe turn some modules on or off, and then come back to the full repository when you have more complex changes in mind.

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