keyboards/planck/readme.md

   1 Planck keyboard firmware
   2 ======================
   3 DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
   4
   5 ## Quantum MK Firmware
   6
   7 For the full Quantum feature list, see [the parent readme.md](/readme.md).
   8
   9 ## Building
  10
  11 Download or clone the whole firmware and navigate to the keyboards/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button.
  12
  13 Depending on which keymap you would like to use, you will have to compile slightly differently.
  14
  15 ### Default
  16 To build with the default keymap, simply run `make default`.
  17
  18 ### Other Keymaps
  19 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 `<name>.c` in the keymaps folder, and see keymap document (you can find in top readme.md) and existent keymap files.
  20
  21 To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
  22
  23 ```
  24 $ make [default|jack|<name>]
  25 ```
  26
  27 Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
  28
  29 ### Notable forks (which some of the keymap files are from)
  30 - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
  31 - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
  32 - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
  33 - [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)