You cannot 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/keyboard/planck
Christopher Browne 211ebe8734 Add in a version key 9 years ago
..
keymaps Add in a version key 9 years ago
old_keymap_files Updated several keyboard folders to use new keymap naming scheme 9 years ago
.gitignore Add support for the KC60 v2.0 2015-09-12 (#360) 9 years ago
Makefile Makefile redo & other features (#395) 9 years ago
README.md Updated several keyboard folders to use new keymap naming scheme 9 years ago
config.h Optimize matrix scanning (#343) 9 years ago
planck.c Move LED strip initialization (#397) 9 years ago
planck.h Leader key implementation (#326) 9 years ago
planck_pcb_r3.hex adds revisions of .hex files for planck/preonic 9 years ago
planck_pcb_r3_w_bootloader.hex adds revisions of .hex files for planck/preonic 9 years ago
planck_pcb_r4.hex removes extra voices, updates .hex files 9 years ago
planck_pcb_r4_w_bootloader.hex removes extra voices, updates .hex files 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 keyboard/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)