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.
668 Commits
34 Branches
19 Tags
23 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd0e0cf3a5c'
${ noResults }
Go to file
Jesse Vincent d0e0cf3a5c
Split out flashing over USB into its own function 		8 years ago
etc Add udev rules for linux, so we don't have problems programming 8 years ago
examples Extract TestMode for the Model 01 (it's going in a plugin) 8 years ago
src Move Storage to the hardware library too 8 years ago
tools Split out flashing over USB into its own function 8 years ago
.gitignore Add a gitignore file 8 years ago
.gitmodules Undo numist's nicer code layout so we can build as a 'regular' arduino sketch 8 years ago
.keyboardio-builder.conf keyboardio-builder: Drop the extra build args 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 Makefile: Major simplification 8 years ago
NOTICE We no longer have the subdir NOTICE was talking about. 8 years ago
README.md add install instructions to readme 8 years ago
library.properties Reintroduce dot_a_linkage 8 years ago

README.md

We're in the midst of refactoring our really bad prototype firmware into a more reasonable production firmware.

Right now, the code is really ugly. It'll be nicer soon. Please don't judge us too harshly.

Getting Started

Pick a directory to work in, you'll need to clone multiple repositories. We'll assume you picked $HOME/keyboardio, 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 Keyboardio 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 keyboardio directory
cd $HOME/keyboardio
# 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/keyboardio
ln -s $HOME/keyboardio/Arduino-Boards $SKETCHBOOK_DIR/hardware/keyboardio/avr

Clone and Build the Keyboardio Firmware

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

<3 jesse

BuildStatus