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.
3799 Commits
34 Branches
19 Tags
23 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '65c8a1f96e'
${ noResults }
Go to file
Gergely Nagy 65c8a1f96e
Merge pull request #666 from tiltowait/idle-leds-efficiency 		5 years ago
bin Renamed virtual architecture "virtual" 5 years ago
doc Keep property public and rename methods to conform to style guide. 5 years ago
etc Renamed virtual architecture "virtual" 5 years ago
examples Keep property public and rename methods to conform to style guide. 5 years ago
extras Initial import 8 years ago
src Merge pull request #666 from tiltowait/idle-leds-efficiency 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.

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

BuildStatus