History

Christopher Browne ce1742a31f Add rule to ignore contents of .build directories; their contents are generated		2016-06-15 18:42:30 -04:00
..
keymaps	Add rule to ignore contents of .build directories; their contents are generated	2016-06-15 18:42:30 -04:00
old_keymap_files	Updated several keyboard folders to use new keymap naming scheme	2016-03-29 21:53:36 -04:00
.gitignore	Should not include the compiled code in the repo	2016-06-15 18:34:47 -04:00
config.h	Optimize matrix scanning (#343 )	2016-05-23 23:42:21 -04:00
Makefile	Makefile redo & other features (#395 )	2016-06-11 13:31:31 -04:00
planck_pcb_r3_w_bootloader.hex	adds revisions of .hex files for planck/preonic	2016-04-25 01:01:41 -04:00
planck_pcb_r3.hex	adds revisions of .hex files for planck/preonic	2016-04-25 01:01:41 -04:00
planck_pcb_r4_w_bootloader.hex	removes extra voices, updates .hex files	2016-04-29 12:42:55 -04:00
planck_pcb_r4.hex	removes extra voices, updates .hex files	2016-04-29 12:42:55 -04:00
planck.c	Move LED strip initialization (#397 )	2016-06-12 18:01:55 -04:00
planck.h	Leader key implementation (#326 )	2016-05-15 00:27:32 -04:00
README.md	Updated several keyboard folders to use new keymap naming scheme	2016-03-29 21:53:36 -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 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.