TerryMathews e2ec45a755 Fix cluepad and planck 9 years ago
..
keymaps e2ec45a755 Fix cluepad and planck 9 years ago
old_keymap_files 649b33d778 Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432) 9 years ago
rev3 197f152dee adds random base64 character generator 9 years ago
rev4 197f152dee adds random base64 character generator 9 years ago
Makefile 215c2119af Implements subprojects and updates projects for this (#459) 9 years ago
config.h 215c2119af Implements subprojects and updates projects for this (#459) 9 years ago
out.txt 4d4f7684e6 Add ChibiOS support for QMK (#465) 9 years ago
planck.c 13bb6b4b7f Backlight abstraction and other changes (#439) 9 years ago
planck.h 215c2119af Implements subprojects and updates projects for this (#459) 9 years ago
readme.md 13bb6b4b7f Backlight abstraction and other changes (#439) 9 years ago

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)