Jack Humbert 66e0323881 removes extra voices, updates .hex files 9 gadi atpakaļ
..
keymaps 66e0323881 removes extra voices, updates .hex files 9 gadi atpakaļ
old_keymap_files 95fba250ef Updated several keyboard folders to use new keymap naming scheme 9 gadi atpakaļ
CYGWIN_GUIDE.md b8d4af8d4a Cygwin Based Users Guide v0.6 -fixes to dfu-programmer build 9 gadi atpakaļ
Makefile a67d425f4d planck default layout updates 9 gadi atpakaļ
PCB_GUIDE.md 3f7180a73e Merge pull request #170 from NoahAndrews/improve-windows-docs 9 gadi atpakaļ
README.md 95fba250ef Updated several keyboard folders to use new keymap naming scheme 9 gadi atpakaļ
backlight.c 1f52d60ef1 Fixed brightness control; Reduced number of brightness levels to 4. 10 gadi atpakaļ
config.h 2597fb7c50 might have broken something 9 gadi atpakaļ
flash-pcb.sh f7bca5c41a ok 10 gadi atpakaļ
planck.c bcebb3447c Add action-preprocessing kb/user hooks in planck 9 gadi atpakaļ
planck.h bcebb3447c Add action-preprocessing kb/user hooks in planck 9 gadi atpakaļ
planck_pcb_r3.hex 28352f4619 adds revisions of .hex files for planck/preonic 9 gadi atpakaļ
planck_pcb_r3_w_bootloader.hex 28352f4619 adds revisions of .hex files for planck/preonic 9 gadi atpakaļ
planck_pcb_r4.hex 66e0323881 removes extra voices, updates .hex files 9 gadi atpakaļ
planck_pcb_r4_w_bootloader.hex 66e0323881 removes extra voices, updates .hex files 9 gadi atpakaļ

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)