History

cbbrowne 1f290f6213 Make my builds smaller		2016-12-01 16:21:15 -05:00
..
keymaps	Make my builds smaller	2016-12-01 16:21:15 -05:00
old_keymap_files	Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432 )	2016-06-21 22:39:54 -04:00
rev3	removes planck/rev3 temporarily	2016-10-18 13:57:56 -04:00
rev4	Split subproject make files into Makefile and rules.mk	2016-08-20 03:56:23 +03:00
config.h	Implements subprojects and updates projects for this (#459 )	2016-06-29 16:21:41 -04:00
Makefile	Split keyboard makefiles into rules and Makefile	2016-08-20 03:56:08 +03:00
out.txt	Add ChibiOS support for QMK (#465 )	2016-07-01 10:04:53 -04:00
planck.c	Add default swap configs for a couple of boards.	2016-08-20 17:46:53 -07:00
planck.h	Implements subprojects and updates projects for this (#459 )	2016-06-29 16:21:41 -04:00
readme.md	Update keyboard readme files with new makefile instructions	2016-08-20 03:56:48 +03:00
rules.mk	separated into api files/folder	2016-11-26 15:38:44 -05:00

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.