keyboard/planck/README.md

   1 Planck keyboard firmware
   2 ======================
   3 DIY/Assembled compact ortholinear keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
   4
   5 ## Notable TMK forks (which some of the keymap files are from)
   6 - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
   7 - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
   8 - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
   9 - [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)
  10
  11 ## Build
  12
  13 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.
  14
  15 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).
  16
  17 Move to this directory then just run `make` like:
  18
  19     $ make
  20
  21 Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.
  22
  23
  24 ## Keymap
  25 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.
  26
  27 To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
  28
  29     $ make KEYMAP=[<name>]