qmk_firmware/keyboard/planck
cwhits 69f05e1afd [planck] adds button for toggling output in plover app ()
* [planck] toggle plover output in app when toggling plover layer on keyboard

* [planck] moved plover toggle to separate key

* [planck] renamed toggle button
..
keymaps [planck] adds button for toggling output in plover app ()
old_keymap_files Updated several keyboard folders to use new keymap naming scheme
CYGWIN_GUIDE.md Cygwin Based Users Guide v0.6 -fixes to dfu-programmer build
Makefile moves backlight functionality to keyboard files and updates template makefile
PCB_GUIDE.md Merge pull request from NoahAndrews/improve-windows-docs
README.md Updated several keyboard folders to use new keymap naming scheme
config.h might have broken something
flash-pcb.sh ok
planck.c Backlight Breathing for Planck and Atomic
planck.h Backlight Breathing for Planck and Atomic
planck_pcb_r3.hex adds revisions of .hex files for planck/preonic
planck_pcb_r3_w_bootloader.hex adds revisions of .hex files for planck/preonic
planck_pcb_r4.hex removes extra voices, updates .hex files
planck_pcb_r4_w_bootloader.hex removes extra voices, updates .hex files

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)