History

Jack Humbert d81135410c Merge pull request #1382 from binaryplease/handwired_binaryplease Handwired binaryplease		2017-06-09 21:09:52 -04:00
..
keymaps	Merge pull request #1382 from binaryplease/handwired_binaryplease	2017-06-09 21:09:52 -04:00
old_keymap_files	Update mitch layout for new keymaps	2017-01-17 13:01:07 -08:00
rev3	adds planck/rev3 makefile so subproject is found	2017-02-12 23:58:44 -05:00
rev4	…
Makefile	…
config.h	revert changes to config.h	2017-05-24 21:24:13 +02:00
planck.c	Update planck.c	2016-12-04 23:11:22 -05:00
planck.h	…
readme.md	…
rules.mk	adds soft pwm for non-timed ports	2017-02-12 11:29:42 -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.