qmk_firmware/keyboard/planck
Nathan Ross Powell e9df959c13 Update keymap_nathan.c
Remove macro for KEYMAP_GRID that is in keymap_common.h.
Add comments with ASCII art for the two layouts in keymap_common.h.
..
Makefile Initial commit for Planck PCB Rev 1.
Makefile.pjrc added planck folder
README.md Update README.md
backlight.c Replaced tabs with spaces to match TMK convention.
backlight.h Added backlight.h, backlight.c
config.h Initial commit for Planck PCB Rev 1.
keymap_brett.c brett
keymap_common.c added planck folder
keymap_common.h Update keymap_nathan.c
keymap_dotcom.c dotcom
keymap_jack.c simon
keymap_joe.c led oops
keymap_matthew.c defined KEYMAP_GRID for grid layouts
keymap_nathan.c Update keymap_nathan.c
keymap_peasant.c dotcom
keymap_sean.c sean
keymap_shane.c Create keymap_shane.c
keymap_simon.c simon
keymap_wilba.c Replaced tabs with spaces to match TMK convention.
led.c Replaced tabs with spaces to match TMK convention.
matrix-handwire.c Rename handwire-matrix.c to matrix-handwire.c
matrix.c Replaced tabs with spaces to match TMK convention.

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