keyboardio/Kaleidoscope

Name: Kaleidoscope

Owner: Keyboardio

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

Created: 2013-11-02 03:59:51.0

Updated: 2018-01-16 14:00:57.0

Pushed: 2018-01-17 23:26:57.0

Homepage: http://keyboard.io

Size: 1251

Language: C

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Kaleidoscope

Flexible firmware for Arduino-powered keyboards.

This package contains the “core” of Kaleidoscope and an example firmware “Sketch.”

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

Pick a directory to work in, you'll need to clone multiple repositories. We'll assume you picked $HOME/kaleidoscope, if you chose another adapt the commands below accordingly.

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.

Install the Kaleidoscope Hardware Definitions
u'll need to know your arduino sketchbook directory

 macOS the default is
CHBOOK_DIR=$HOME/Documents/Arduino
 Linux the default is
CHBOOK_DIR=$HOME/Arduino

 to your kaleidoscope directory
HOME/kaleidoscope
en clone the hardware definitions
clone --recursive https://github.com/keyboardio/Arduino-Boards.git
d make them available to the arduino environment
r -p $SKETCHBOOK_DIR/hardware/keyboardio
s $HOME/kaleidoscope/Arduino-Boards $SKETCHBOOK_DIR/hardware/keyboardio/avr
Clone and Build the Kaleidoscope Firmware
 to your keyboardio directory
HOME/kaleidoscope
en clone the firmware repository
clone https://github.com/keyboardio/Kaleidoscope.git
d build your firmware!
aleidoscope

<3 jesse

Build Status


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.