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/keyboard/planck
Jack Humbert e6a2c77fde
README changes
9 years ago
..
keymaps Remove obsolete comments 9 years ago
old_keymap_files making the extended keymap the default - no more 'common' 9 years ago
Makefile no message 9 years ago
PCB_GUIDE.md Update PCB_GUIDE.md 9 years ago
README.md README changes 9 years ago
backlight.c ok 9 years ago
config.h Integrate WS2812 code into quantum core 9 years ago
flash-pcb.sh ok 9 years ago
planck.c Add support for WS2812 LEDs 9 years ago
planck.h Add support for WS2812 LEDs 9 years ago
planck_pcb.hex pcb hex 9 years ago
planck_with_bootloader.hex bluetooth 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 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)