Firmware for the Keyboardio Model 01 and other keyboards with AVR or ARM MCUs.

Go to file

Jesse Vincent b3ef48dcce Migrate Kaleidoscope-Leader to the plugins directory		4 years ago
.github	add back other two issue templates	4 years ago
bin	Migrate build-arduino-package from the larger bundle repo.	4 years ago
docs	remove documentation about paths, snaps, and flatpaks that was not relevant to our quickstart	4 years ago
etc	Teach the makefile builder to look for Kaleidoscople plugin libraries inside the plugins directory	4 years ago
examples	Move the HostOS plugin into the plugins directory	4 years ago
extras	Initial import	8 years ago
plugins	Migrate Kaleidoscope-Leader to the plugins directory	4 years ago
src	Migrate Kaleidoscope-Leader to the plugins directory	4 years ago
test/MatrixAddr	Update linear addressing branch for firmware drift	6 years ago
testing	Add the ability to have "TODO" test sections that gtest interprets as 'DISABLED'	4 years ago
tests	Move key def sections into a subdirectory to make the codebase a bit cleaner.	4 years ago
.astylerc	Clean up astyle invocations based on @gendankenexperimenter's KeyboardioHID cleanups	4 years ago
.gitignore	Update gitignore files to ignore .arduino and to stop ignoring testing/bin	4 years ago
.kaleidoscope-builder.conf	Remove the hook for the now-removed layout transformation script	8 years ago
.readthedocs.yml	try to get rtd to see our master doc	5 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	Clean up astyle invocations based on @gendankenexperimenter's KeyboardioHID cleanups	4 years ago
README.md	Update README for new build and setup instructions	4 years ago
library.properties	library.properties: Remove the AVR architecture restriction	5 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

If you want to use Kaleidoscope to customize or compile a "sketch" to power a supported keyboard, the fastest way to get started is to use the Arduino IDE. You can find setup instructions on kaleidoscope.readthedocs.io

If you prefer to work from the command line or intend to work on Kaleidscope itself, please follow the instructions below

Use git to check out a copy of Kaleidoscope

Open a commandline shell and navigate to where you want to check out Kaleidoscope.

For the purposes of this tutorial, we'll assume your checkout is in a directory called kaleidoscope inside a directory called git in your home directory.

$ mkdir ${HOME}/git
$ cd ${HOME}/git

Use git to download the latest version of Kaleidoscope

$ git clone https://github.com/keyboardio/Kaleidoscope

Ask Kaleidoscope to install the compiler toolchain, arduino-cli and platform support

$ cd ${HOME}/git/Kaleidoscope
$ make setup

Tell your shell where to find your Kaleidoscope installation. This example is for bash. If you're using another shell, consult the shell's documentation for instructions about how to set an environment variable

$ export KALEIDOSCOPE_DIR=${HOME}/git/Kaleidoscope

$ echo "export KALEIDOSCOPE_DIR=${HOME}/git/Kaleidoscope" >> ${HOME}/.bash_profile

Build the Kaleidoscope Firmware for your keyboard

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

$ cd examples/Devices/Keyboardio/Atreus

$ make compile

Install your firmware

$ make flash

<3 jesse