qmk-dactyl-manuform-a/keyboard/planck
Jack Humbert a2ee277158 updated comments about plover 2016-04-19 17:03:43 -04:00
..
keymaps updated comments about plover 2016-04-19 17:03:43 -04:00
old_keymap_files Updated several keyboard folders to use new keymap naming scheme 2016-03-29 21:53:36 -04:00
CYGWIN_GUIDE.md Cygwin Based Users Guide v0.6 -fixes to dfu-programmer build 2016-03-14 13:19:29 -04:00
Makefile planck default layout updates 2016-04-17 01:00:39 -04:00
PCB_GUIDE.md Merge pull request #170 from NoahAndrews/improve-windows-docs 2016-03-04 10:19:00 -05:00
README.md Updated several keyboard folders to use new keymap naming scheme 2016-03-29 21:53:36 -04:00
backlight.c ok 2015-08-16 17:52:49 -04:00
config.h might have broken something 2016-04-14 23:33:46 -04:00
flash-pcb.sh ok 2015-08-16 17:52:03 -04:00
planck.c Add action-preprocessing kb/user hooks in planck 2016-03-28 16:49:47 +02:00
planck.h Add action-preprocessing kb/user hooks in planck 2016-03-28 16:49:47 +02:00
planck_pcb.hex pcb hex 2015-09-26 00:39:48 -04:00
planck_with_bootloader.hex bluetooth 2015-10-22 13:37:45 -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.

Notable forks (which some of the keymap files are from)