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

Go to file

Gergely Nagy f7834f05fc Merge the hooks into the Kaleidoscope object Having the hooks, and the hook methods in the Kaleidoscope object means we don't have to litter the definitions of the arrays around, and that the hooks are more tied to the object. We pollute the global namespace less, and having them in the object means that the hook helper functions will not be optimized out if not used within the Kaleidoscope repo. All in all, this saves us about 56 bytes of code, allows us to remove some hacks, and pulls things that are closely knit, closer together. While there, also changed the name of the `custom_handler_t` and `custom_loop_t` types to `eventHandlerHook` and `loopHook` (both under the `Kaleidoscope_` class), to better reflect what they are for. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>		8 years ago
etc	Add udev rules for linux, so we don't have problems programming	8 years ago
examples	Move the sample layouts into the firmware sketch	8 years ago
src	Merge the hooks into the Kaleidoscope object	8 years ago
tools	Move the sample layouts into the firmware sketch	8 years ago
.gitignore	Add a gitignore file	8 years ago
.kaleidoscope-builder.conf	Remove the hook for the now-removed layout transformation script	8 years ago
.travis.yml	travis: Call make build-all to build all the examples	8 years ago
LICENSE	Update the text of the GPL-2 to the latest text	8 years ago
Makefile	The Big Rename	8 years ago
NOTICE	We no longer have the subdir NOTICE was talking about.	8 years ago
README.md	README updates	8 years ago
library.properties	The Big Rename	8 years ago

README.md

Kaleidoscope

Flexible firmware for Arduino-powered keyboards

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.

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.

Install the Kaleidoscope Hardware Definitions

# you'll need to know your arduino sketchbook directory

# on macOS the default is
SKETCHBOOK_DIR=$HOME/Documents/Arduino
# on Linux the default is
SKETCHBOOK_DIR=$HOME/Arduino

# go to your kaleidoscope directory
cd $HOME/kaleidoscope
# then clone the hardware definitions
git clone --recursive https://github.com/keyboardio/Arduino-Boards.git
# and make them available to the arduino environment
mkdir -p $SKETCHBOOK_DIR/hardware/kaleidoscope
ln -s $HOME/kaleidoscope/Arduino-Boards $SKETCHBOOK_DIR/hardware/kaleidoscope/avr

Clone and Build the Kaleidoscope Firmware

# go to your keyboardio directory
cd $HOME/kaleidoscope
# then clone the firmware repository
git clone https://github.com/keyboardio/Kaleidoscope.git
# and build your firmware!
cd Kaleidoscope
make

<3 jesse