keyboard/planck/README.md

   1 Planck keyboard firmware
   2 ======================
   3 DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
   4
   5 ## Extended Keymap
   6 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:
   7
   8 - Use `LSFT()`, `LCTL()`, et. al. (listed in extended_keymap_common.h) as modifiers for keys (daisy-chain-able)
   9 - Use `FUNC(1)` instead of `FN1` (etc.) to access the function layers beyond the 32 function layer limit
  10 - Use `CM_F` instead of `KC_F` to get the ColeMak equivilent for shortcuts (maps backwards)
  11 - Use `MACRODOWN()` instead of `MACRO()` to easily make a keydown macro (`CM_*` works here too)
  12
  13 ### Some notes on usage:
  14
  15 - 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
  16 - Keep an eye on the Makefile - this needs to include the correct files to work
  17 - Don't forget to use `const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {` instead of the 8bit equivilent
  18
  19 ## Build
  20
  21 Follow [this guide](http://deskthority.net/workshop-f7/how-to-build-your-very-own-keyboard-firmware-t7177.html) to setup your development environment before anything else. Abbreviated instructions are provide at the [bottom of this document](https://github.com/rswiernik/tmk_keyboard/tree/rswiernik_dev/keyboard/planck#environment-setup)
  22
  23 Download the whole firmware [here](https://github.com/jackhumbert/tmk_keyboard/archive/master.zip) 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).
  24
  25 Depending on which keymap you would like to use, you will have to compile slightly differently.
  26
  27 ####Default
  28 To build with the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows:
  29 ```
  30 $ make
  31 ```
  32
  33 ## Keymap
  34 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.
  35
  36 ####**Extended Keymaps**
  37
  38 To build the firmware binary hex file with an extended keymap just do `make` with `KEYMAP` option like:
  39 ```
  40 $ make KEYMAP=[common|jack|<name>]
  41 ```
  42 _The only applicable keymaps will work with this option._ Extended keymaps follow the format **__extended\_keymap\_\<name\>.c__**
  43
  44 ####**Common Keymaps**
  45
  46 Building with a common keymap is as simple as adding the COMMON option. Note that only
  47 ```
  48 $ make KEYMAP=[common|jack|<name>] COMMON=true
  49 ```
  50 _The only applicable keymaps will work with this option._ Common keymaps follow the format **__keymap\_\<name\>.c__**
  51
  52 ## Notable TMK forks (which some of the keymap files are from)
  53 - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
  54 - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
  55 - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
  56 - [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)