History

root 1a8042ae91 Added personal keymap with underglow, right shift, numpad, and bright hidden behind raise/lower		7 years ago
..
keymaps	Added personal keymap with underglow, right shift, numpad, and bright hidden behind raise/lower	7 years ago
old_keymap_files	Update mitch layout for new keymaps	7 years ago
rev3	adds planck/rev3 makefile so subproject is found	7 years ago
rev4	Split subproject make files into Makefile and rules.mk	8 years ago
Makefile	Split keyboard makefiles into rules and Makefile	8 years ago
config.h	revert changes to config.h	7 years ago
planck.c	Update planck.c	8 years ago
planck.h	Implements subprojects and updates projects for this (#459 )	8 years ago
readme.md	Update keyboard readme files with new makefile instructions	8 years ago
rules.mk	adds soft pwm for non-timed ports	7 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 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.