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.
4515 Commits
34 Branches
19 Tags
23 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5c9429982e'
${ noResults }
Go to file
Jesse Vincent 5c9429982e
ordering matters 		4 years ago
.github/workflows ordering matters 4 years ago
.travis Try to make the travis ramdisk setup tool a bit shellcheck friendlier 4 years ago
bin Add a deprecation warning to the "old" kaleidoscope-builder 4 years ago
docs update classic Atreus docs for the arduino-cli world 4 years ago
etc Update our docker config to use a layout that better matches arduino-cli 4 years ago
examples Update example and testing sketches to use new makefiles 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 Update example and testing sketches to use new makefiles 4 years ago
tests Improve dependency tracking, cleanup and presentation in test Makefiles. 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
.travis.yml Update travis config for the new world order 4 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 Replace kaleidoscope-builder with makefiles using arduino-cli 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

  1. 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 ~/git
$ cd ~/git
  1. Use git to download the latest version of Kaleidoscope
$ git clone https://github.com/keyboardio/Kaleidoscope
  1. Ask Kaleidoscope to install the compiler toolchain, arduino-cli and platform support
$ cd Kaleidoscope
$ make setup
  1. 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
  1. Install your firmware
$ make flash

<3 jesse