You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qmk_firmware/keyboards/planck
Jack Humbert 65faab3b89
Moves features to their own files (process_*), adds tap dance feature (#460)
8 years ago
..
keymaps Implements subprojects and updates projects for this (#459) 8 years ago
old_keymap_files Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432) 8 years ago
rev3 Moves features to their own files (process_*), adds tap dance feature (#460) 8 years ago
rev4 Implements subprojects and updates projects for this (#459) 8 years ago
Makefile Implements subprojects and updates projects for this (#459) 8 years ago
config.h Implements subprojects and updates projects for this (#459) 8 years ago
planck.c Backlight abstraction and other changes (#439) 8 years ago
planck.h Implements subprojects and updates projects for this (#459) 8 years ago
readme.md Backlight abstraction and other changes (#439) 8 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)