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 the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows:
  29 ```
  30 $ make
  31 ```
  32
  33 ####**Extended Keymaps**
  34
  35 Extended keymaps need to be specified as follows:
  36 ```
  37 $ make KEYMAP=[common|jack|<name>]
  38 ```
  39 Applicable keymaps should follow the format **__extended\_keymap\_name.c__**
  40
  41 ####**Common Keymaps**
  42
  43 Common keymaps need to be specified as follows:
  44 ```
  45 $ make KEYMAP=[common|jack|<name>] COMMON=true
  46 ```
  47 Applicable keymaps should follow the format **__keymap\_name.c__**
  48
  49 ## Keymap
  50 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.
  51
  52 To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
  53
  54     $ make KEYMAP=[<name>]
  55
  56 ## Notable TMK forks (which some of the keymap files are from)
  57 - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
  58 - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
  59 - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
  60 - [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)
  61
  62 ## Environment Setup
  63