d0391d9ed7
This stupid readme... |
10 years ago | |
---|---|---|
.. | ||
Makefile | 10 years ago | |
Makefile.pjrc | 10 years ago | |
README.md | 10 years ago | |
backlight.c | 10 years ago | |
backlight.h | 10 years ago | |
config.h | 10 years ago | |
extended_keymap_common.c | 10 years ago | |
extended_keymap_common.h | 10 years ago | |
extended_keymap_jack.c | 10 years ago | |
keymap_brett.c | 10 years ago | |
keymap_common.c | 10 years ago | |
keymap_common.h | 10 years ago | |
keymap_dotcom.c | 10 years ago | |
keymap_jack.c | 10 years ago | |
keymap_joe.c | 10 years ago | |
keymap_matthew.c | 10 years ago | |
keymap_nathan.c | 10 years ago | |
keymap_peasant.c | 10 years ago | |
keymap_reed.c | 10 years ago | |
keymap_sean.c | 10 years ago | |
keymap_shane.c | 10 years ago | |
keymap_simon.c | 10 years ago | |
keymap_tim.c | 10 years ago | |
keymap_wilba.c | 10 years ago | |
led.c | 10 years ago | |
matrix.c | 10 years ago | |
matrix_center.c | 10 years ago | |
matrix_handwire.c | 10 years ago |
README.md
Planck keyboard firmware
DIY/Assembled compact ortholinear 40% keyboard by Ortholinear Keyboards.
Extended Keymap
If you include extended_keymap_common.h instead of keymap_common.h at the top of your file, you'll have access to a bunch of goodies:
- Use
LSFT()
,LCTL()
, et. al. (listed in extended_keymap_common.h) as modifiers for keys (daisy-chain-able) - Use
FUNC(1)
instead ofFN1
(etc.) to access the function layers beyond the 32 function layer limit - Use
CM_F
instead ofKC_F
to get the ColeMak equivilent for shortcuts (maps backwards) - Use
MACRODOWN()
instead ofMACRO()
to easily make a keydown macro (CM_*
works here too)
Some notes on usage:
- The
KEYMAP()
macro is unable to be used due to the bitwise modifications that take place - refer to extended_keymap_jack.c to see how to set things up with theKC_
prefix - Keep an eye on the Makefile - this needs to include the correct files to work
- Don't forget to use
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
instead of the 8bit equivilent
Build
Follow this guide to setup your development environment before anything else. Abbreviated instructions are provide at the bottom of this document
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).
Depending on which keymap you would like to use, you will have to compile slightly differently.
####Default
To build the default keymap, simply move to the tmk_keyboard/keyboard/planck/ and run make
as follows:
$ make
####Extended Keymaps
Extended keymaps need to be specified as follows:
$ make KEYMAP=[common|jack|<name>]
Applicable keymaps should follow the format extended_keymap_.c
####Common Keymaps
Common keymaps need to be specified as follows:
$ make KEYMAP=[common|jack|<name>] COMMON=true
Applicable keymaps should follow the format keymap_.c
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>]