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

Go to file

Gergely Nagy bf841b4eff Macros: Implement a compact sequence step This introduces two new macro action steps: `MACRO_ACTION_STEP_TAP_SEQUENCE`, and `MACRO_ACTION_STEP_TAP_CODE_SEQUENCE`. Both of these will tap everything that follows up to a terminating zero (or in case of the first, double zeroes). The purpose of these new steps is to allow one to store longer sequences of tapped input in a more compact manner, without having to prefix each step with an action. Signed-off-by: Gergely Nagy <algernon@keyboard.io>		5 years ago
bin	Renamed virtual architecture "virtual"	5 years ago
doc	Macros: Implement a compact sequence step	5 years ago
etc	Renamed virtual architecture "virtual"	5 years ago
examples	Merge pull request #640 from gedankenexperimenter/qukeys.rewrite	5 years ago
extras	Initial import	8 years ago
src	Macros: Implement a compact sequence step	5 years ago
test/MatrixAddr	Update linear addressing branch for firmware drift	5 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	CONTRIBUTING.md: Add a very short section about how to accept the DCO	6 years ago
LICENSE	License clarificataion & copyright headers	6 years ago
Makefile	Update Makefile with OSX fixes and new paths	7 years ago
NEWS.md	add turbo plugin	6 years ago
README.md	inserted missing ```sh	5 years ago
UPGRADING.md	Update linear addressing branch for firmware drift	5 years ago
library.properties	The Big Rename	8 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.6, since older version may not support all required features.

On Linux, follow the instructions on the wiki.
On macOS, install using homebrew cask with brew cask install arduino or download the application from the official website and move it to your /Applications folder.

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

TODO: Write me

Install the libraries and hardware definitions

Clone the hardware definitions

git clone --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