qmk_firmware/keyboards/planck
TerryMathews e2ec45a755 Fix cluepad and planck 2016-07-07 23:57:11 -04:00
..
keymaps Fix cluepad and planck 2016-07-07 23:57:11 -04: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 adds random base64 character generator 2016-06-29 18:29:20 -04:00
rev4 adds random base64 character generator 2016-06-29 18:29:20 -04:00
Makefile Implements subprojects and updates projects for this (#459) 2016-06-29 16:21:41 -04:00
config.h Implements subprojects and updates projects for this (#459) 2016-06-29 16:21:41 -04:00
out.txt Add ChibiOS support for QMK (#465) 2016-07-01 10:04:53 -04:00
planck.c Backlight abstraction and other changes (#439) 2016-06-23 22:18:20 -04:00
planck.h Implements subprojects and updates projects for this (#459) 2016-06-29 16:21:41 -04:00
readme.md Backlight abstraction and other changes (#439) 2016-06-23 22:18:20 -04: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.

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 KEYMAP option like:

$ make KEYMAP=[default|jack|<name>]

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

Notable forks (which some of the keymap files are from)