qmk_firmware/quantum/template

%KEYBOARD% keyboard firmware

Generated firmware for the Quantum MK firmware

Quantum MK Firmware

You have access to a bunch of goodies:

• Use LSFT(), LCTL(), et. al. (listed in keymap_common.h) as modifiers for keys (daisy-chain-able)
• Use FUNC(1) instead of FN1 (etc.) to access the function layers beyond the 32 function layer limit
• Use CM_F instead of KC_F to get the ColeMak equivilent for shortcuts (maps backwards)
• Use MACRODOWN() instead of MACRO() 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 the KC_ 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 with the default keymap, simply move to the tmk_keyboard/keyboard/planck/ and run make as follows:

$ make

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.

####Keymaps

To build the firmware binary hex file with an extended keymap just do make with KEYMAP option like:

$ make KEYMAP=[default|jack|<name>]

The only applicable keymaps will work with this option. Keymaps follow the format keymap_<name>.c and are stored in the keymaps folder.