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.
3731 Commits
34 Branches
19 Tags
23 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'dd5605f173'
${ noResults }
Go to file
Jesse Vincent dd5605f173
Merge pull request #648 from CapeLeidokos/ng_remove_handleKeyswitchEvent_hack 		6 years ago
bin Fixed Kaleidoscope Builder for Arduino paths containing whitespaces 6 years ago
doc Merge pull request #575 from keyboardio/numist/numpad-avoids-numlock 6 years ago
etc Fixed Kaleidoscope Builder for Arduino paths containing whitespaces 6 years ago
examples Update wavepool example ot use the "KEYMAP" macro 6 years ago
extras Initial import 8 years ago
src Merge pull request #648 from CapeLeidokos/ng_remove_handleKeyswitchEvent_hack 6 years ago
.gitignore .gitignore: Ignore compiled examples too 6 years ago
.kaleidoscope-builder.conf Remove the hook for the now-removed layout transformation script 8 years ago
.travis.yml attempt to get travis to use our fancy new caching 6 years ago
CODE_OF_CONDUCT.md Code of conduct 8 years ago
CONTRIBUTING.md Remove files we do not need in the monorepo 6 years ago
LICENSE License clarificataion & copyright headers 6 years ago
Makefile Remove files we do not need in the monorepo 6 years ago
NEWS.md Add NEWS and UPGRADING notes for the PER_KEY_DATA feature changes 6 years ago
README.md README.md: Fix the example link 6 years ago
UPGRADING.md Add NEWS and UPGRADING notes for the PER_KEY_DATA feature changes 6 years ago
library.properties Remove files we do not need in the monorepo 6 years ago

README.md

Kaleidoscope

Flexible firmware for Arduino-powered keyboards.

This package contains the "core" of Kaleidoscope and a number of example firmware "Sketches".

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/Kaleidoscope-Bundle-Keyboardio.git
# and make them available to the arduino environment
mkdir -p $SKETCHBOOK_DIR/hardware
ln -s $HOME/kaleidoscope/Kaleidoscope-Bundle-Keyboardio $SKETCHBOOK_DIR/hardware/keyboardio

Build the Kaleidoscope Firmware for your keyboard

# go to your keyboardio directory
cd $HOME/kaleidoscope/Kaleidoscope-Bundle-Keyboardio/avr/libraries/Model01-Firmware
# and build your firmware!
make

<3 jesse

BuildStatus