1
0
Fork 0
qmk_firmware/keyboard/planck
Nathan Ross Powell e958baca81 Delete .keymap_nathan.c.swp 2015-03-18 23:39:01 -04:00
..
Makefile Initial commit for Planck PCB Rev 1. 2015-03-17 00:43:37 +11:00
Makefile.pjrc added planck folder 2014-12-14 10:30:27 -05:00
README.md Update README.md 2015-03-18 10:19:40 -04:00
backlight.c Replaced tabs with spaces to match TMK convention. 2015-03-17 00:56:41 +11:00
backlight.h Added backlight.h, backlight.c 2015-03-17 00:51:36 +11:00
config.h Initial commit for Planck PCB Rev 1. 2015-03-17 00:43:37 +11:00
keymap_brett.c brett 2015-03-05 14:29:33 -05:00
keymap_common.c added planck folder 2014-12-14 10:30:27 -05:00
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
keymap_wilba.c Replaced tabs with spaces to match TMK convention. 2015-03-17 00:56:41 +11:00
led.c Replaced tabs with spaces to match TMK convention. 2015-03-17 00:56:41 +11:00
matrix-handwire.c Rename handwire-matrix.c to matrix-handwire.c 2015-03-16 11:59:49 -04:00
matrix.c Replaced tabs with spaces to match TMK convention. 2015-03-17 00:56:41 +11: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

Follow this guide to setup your development environment before anything else.

Download the whole firmware here and navigate to the keyboard/planck folder. Once your dev env is setup, you'll be able to type "make" to generate your .hex that you can load with the Teensy app onto your Planck (once you've hit reset/shorted GND & RST).

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>]