History

Dylan Khor a875299d9a Added breathing macros and removed mappings to unused layouts		2017-04-09 02:02:40 -04:00
..
keymaps	Added breathing macros and removed mappings to unused layouts	2017-04-09 02:02:40 -04:00
old_keymap_files
rev3	adds planck/rev3 makefile so subproject is found	2017-02-12 23:58:44 -05:00
rev4
config.h
Makefile
planck.c
planck.h
readme.md
rules.mk

readme.md

Planck keyboard firmware

DIY/Assembled compact ortholinear 40% keyboard by Ortholinear Keyboards.

Quantum MK Firmware

For the full Quantum feature list, see the parent readme.md.

Building

Download or clone the whole firmware and navigate to the keyboards/planck folder. Once your dev env is setup, you'll be able to type make to generate your .hex - you can then use make dfu to program your PCB once you hit the reset button.

Depending on which keymap you would like to use, you will have to compile slightly differently.

Default

To build with the default keymap, simply run make default.

Other Keymaps

Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named <name>.c in the keymaps folder, and see keymap document (you can find in top readme.md) and existent keymap files.

To build the firmware binary hex file with a keymap just do make with a keymap like this:

$ make [default|jack|<name>]

Keymaps follow the format <name>.c and are stored in the keymaps folder.