qmk_firmware/keyboard/planck
Jack Humbert fde477a927 updates midi functionality (#331)
* implements leader key for planck experimental

* allows override of leader timeout

* adds ability to use the leader key in seq

* fixes leader keycode

* adds chording prototype

* fixes keycode detection

* moves music mode to quantum.c

* disables chording by default

* adds music sequencer functionality

* implements audio/music functions in quantum.c

* splits up process_action to allow independent processing of actions

* moves midi stuff to quantum.c

* adds additional scales for midi
2016-05-15 00:51:06 -04:00
..
keymaps updates midi functionality (#331) 2016-05-15 00:51:06 -04:00
old_keymap_files
config.h
CYGWIN_GUIDE.md
flash-pcb.sh
Makefile
PCB_GUIDE.md
planck.c Leader key implementation (#326) 2016-05-15 00:27:32 -04:00
planck.h Leader key implementation (#326) 2016-05-15 00:27:32 -04:00
planck_pcb_r3.hex
planck_pcb_r3_w_bootloader.hex
planck_pcb_r4.hex
planck_pcb_r4_w_bootloader.hex
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)