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.
4759 Commits
34 Branches
19 Tags
23 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b8755d1def'
${ noResults }
Go to file
Jesse Vincent b8755d1def
TEST_OBJS is a dependency for compiliation. This only broke during parallel builds 		4 years ago
.github/workflows install ccahe on gh 4 years ago
.travis Try to make the travis ramdisk setup tool a bit shellcheck friendlier 4 years ago
bin make the docker filesystem layout look more like the modern world 4 years ago
docs update classic Atreus docs for the arduino-cli world 4 years ago
etc silence an 'install' line from the Makefile 4 years ago
examples The model 01 now needs to have its props specified 4 years ago
extras Initial import 8 years ago
src Suppress idle keyswitch events from virtual hardware device 4 years ago
test/MatrixAddr Update linear addressing branch for firmware drift 5 years ago
testing TEST_OBJS is a dependency for compiliation. This only broke during parallel builds 4 years ago
tests make the docker filesystem layout look more like the modern world 4 years ago
.gitignore don't package up arduino-cli when trying to run in docker 4 years ago
.readthedocs.yml try to get rtd to see our master doc 5 years ago
.travis.yml kaleidoscope-builder is no more. 4 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 try to force the etc dir 4 years ago
README.md Add a note about symlinks on Windows, thanks to Johannes Becker. 5 years ago
library.properties change to library.properties to force ci 4 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

Setup the Arduino IDE

Setup the Arduino IDE on your system. Make sure you install at least version 1.8.6, since older version may not support all required features.

Get into the right directory

macOS

mkdir -p $HOME/Documents/Arduino/hardware
cd $HOME/Documents/Arduino/hardware

Linux

mkdir -p $HOME/Arduino/hardware
cd $HOME/Arduino/hardware

Windows (Assuming cmd)

mkdir %userprofile%\Documents\Arduino\hardware
cd %userprofile%\Documents\Arduino\hardware

Install the libraries and hardware definitions

Clone the hardware definitions

Because git for Windows doesn't always have symlink support enabled by default, you may need to enable it for Kaleidoscope. To do that, add '-c core.symlinks=true' to your commandline. On all other platforms, that option is safe, but not necessary, as symlinks should work by default.

git clone -c core.symlinks=true --recursive https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio.git keyboardio

Build the Kaleidoscope Firmware for your keyboard

(This part assumes you're building firmware for the Keyboardio Model 01)

# Go to your device firmware directory
cd keyboardio/avr/libraries/Model01-Firmware

# Build your firmware!
make


# Install your firmware
make flash

<3 jesse

BuildStatus