qmk-firmware/keyboard/planck
Jack Humbert 0fcb3b65f8 brett 2015-03-05 14:29:33 -05:00
..
Makefile brett 2015-02-26 16:35:54 -05:00
Makefile.pjrc
README.md Update README.md 2015-01-23 12:11:28 -05:00
config.h
keymap_brett.c brett 2015-03-05 14:29:33 -05:00
keymap_common.c
keymap_common.h defined KEYMAP_GRID for grid layouts 2015-01-23 14:17:32 -05:00
keymap_dotcom.c dotcom 2015-01-05 16:32:15 -05:00
keymap_jack.c simon 2015-03-02 20:37:17 -05:00
keymap_joe.c led oops 2015-02-23 23:44:11 -05:00
keymap_matthew.c defined KEYMAP_GRID for grid layouts 2015-01-23 14:17:32 -05:00
keymap_nathan.c Create keymap_nathan.c 2015-01-23 12:14:55 -05:00
keymap_peasant.c dotcom 2015-01-05 16:27:03 -05:00
keymap_sean.c sean 2015-02-15 16:29:35 -05:00
keymap_shane.c Create keymap_shane.c 2015-01-14 21:36:25 -05:00
keymap_simon.c simon 2015-03-02 20:37:17 -05:00
led.c led oops 2015-02-23 23:44:11 -05:00
matrix.c sean 2015-01-13 18:05:37 -05:00

README.md

Planck keyboard firmware

DIY/Assembled compact ortholinear keyboard by Ortholinear Keyboards.

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

Build

Move to this directory then just run make like:

$ make

Use make -f Makefile.pjrc if you want to use PJRC stack but I find no reason to do so now.

Keymap

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 keymap_<name>.c and see keymap document(you can find in top README.md) and existent keymap files.

To build firmware binary hex file with a certain keymap just do make with KEYMAP option like:

$ make KEYMAP=[<name>]