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

Go to file

Jesse Vincent dbeed3c767 Apply some of our makefile optimization techniques to the test suite		3 years ago
.github	We don't need to run 'make setup' for the various linting targets	3 years ago
bin	Add include-what-you-use script for fixing header includes	3 years ago
docs	Update code style guide for header include updates	3 years ago
etc	Arduino-cli 0.14 is ancient and unsupported.	3 years ago
examples	Update headers for example sketches	3 years ago
extras	Initial import	8 years ago
plugins	Standardize namespace block closing comments	3 years ago
src	Standardize namespace block closing comments	3 years ago
test/MatrixAddr	Update linear addressing branch for firmware drift	5 years ago
testing	Apply some of our makefile optimization techniques to the test suite	3 years ago
tests	Apply some of our makefile optimization techniques to the test suite	3 years ago
.astylerc	Clean up astyle invocations based on @gendankenexperimenter's KeyboardioHID cleanups	4 years ago
.gitignore	Ignore the docs/plugins dir which hosts copied plugin docs at build time	4 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	Use := syntax for when we call $(shell) in our makefiles.	3 years ago
README.md	Update README to say that the Arduino IDE and git checkouts are not friends	4 years ago
library.properties	fix paragraph section in Kaleidsocope library.properties	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

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. It's important to note that the Arduino IDE needs the source code laid out in a slightly different arrangement than you'll find in this repository. If you want to use the Arduino IDE, you should follow these instructions instead.

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

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