Nathan Ross Powell 80c4cdb245 Merge remote-tracking branch 'upstream/master' 11 anni fa
..
.keymap_nathan.c.swp e7289bb029 KC_INSERT should be KC_INS 11 anni fa
Makefile 15b9bce6ba Initial commit for Planck PCB Rev 1. 11 anni fa
Makefile.pjrc ed8d9a099d added planck folder 11 anni fa
README.md 9c3a956634 Update README.md 11 anni fa
backlight.c 65680819df Replaced tabs with spaces to match TMK convention. 11 anni fa
backlight.h b80b6b369c Added backlight.h, backlight.c 11 anni fa
config.h 15b9bce6ba Initial commit for Planck PCB Rev 1. 11 anni fa
keymap_brett.c 0fcb3b65f8 brett 11 anni fa
keymap_common.c ed8d9a099d added planck folder 11 anni fa
keymap_common.h 438ff3465e defined KEYMAP_GRID for grid layouts 11 anni fa
keymap_dotcom.c d6f2f878f9 dotcom 11 anni fa
keymap_jack.c ceff93844b simon 11 anni fa
keymap_joe.c a538f71e41 led oops 11 anni fa
keymap_matthew.c 438ff3465e defined KEYMAP_GRID for grid layouts 11 anni fa
keymap_nathan.c 09655cc5d5 Create keymap_nathan.c 11 anni fa
keymap_peasant.c 33e2a6285f dotcom 11 anni fa
keymap_sean.c 4a3c0839f9 sean 11 anni fa
keymap_shane.c 173dbe3b28 Create keymap_shane.c 11 anni fa
keymap_simon.c ceff93844b simon 11 anni fa
keymap_wilba.c 65680819df Replaced tabs with spaces to match TMK convention. 11 anni fa
led.c 65680819df Replaced tabs with spaces to match TMK convention. 11 anni fa
matrix-handwire.c be86aefdbd Rename handwire-matrix.c to matrix-handwire.c 11 anni fa
matrix.c 65680819df Replaced tabs with spaces to match TMK convention. 11 anni fa

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