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

Go to file

Michael Richters 9b04d6663c Run IWYU (with the new tools) on test simulator code This mixes some manual work (IWYU pragmas, a better solution to the Arduino preprocessor macros problem) with automated running of the tools. At this point, it would be too much work to separate these into distinct commits, and there isn't that much value to doing so. There are still some things we could do to make things more robust, as some of the headers need to be in a certain order, which happens to be in the same sort order used by IWYU (`testing/*` files need to come after certain headers than include `Arduino.h`), but it's probably not worth the clutter of adding an `#if 1` just to stop IWYU from re-ordering them. I tried to get `#pragma push_macro("max")/pop_macro("max")` to work, but ended up getting completely nonsensical compilation errors, so I gave up on it. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>		2 years ago
.github	Rename `check-formatting` to `check-code-style`	2 years ago
bin	Update Makefile and add wrapper script for managing header includes	2 years ago
docs	Update code style docs with IWYU info	2 years ago
etc	Use make's built-in `.DEFAULT_GOAL` variable to set default target(s)	2 years ago
examples	Add example sketch for MouseKeys	2 years ago
extras	Initial import	8 years ago
plugins	Add example sketch for MouseKeys	2 years ago
src	Rename `TEST()` macro to avoid conflicts with gtest	2 years ago
test/MatrixAddr	Format codebase with `clang-format`	3 years ago
testing	Run IWYU (with the new tools) on test simulator code	2 years ago
tests	Run IWYU (with the new tools) on test simulator code	2 years ago
.astylerc	Clean up astyle invocations based on @gendankenexperimenter's KeyboardioHID cleanups	4 years ago
.clang-format	Switch from astyle to clang-format for automated code formatting	3 years ago
.cpplint	Use config files for cpplint options	2 years ago
.cpplint-noisy	Use config files for cpplint options	2 years ago
.gitignore	Ignore the docs/plugins dir which hosts copied plugin docs at build time	4 years ago
.iwyu_ignore	Ignore files from gtest and examples when running IWYU	2 years ago
.readthedocs.yml	try to get rtd to see our master doc	5 years ago
CODE_OF_CONDUCT.md	Code of conduct	7 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	Update Makefile and add wrapper script for managing header includes	2 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