adds backlight levels to the satan keyboard (#431)

[qmk_firmware.git] / keyboard / planck / README.md

diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md
index cb009c005dc794d8e3786e41da5bb70970cc54da..d9a1e3beeebd6e6e8e50b49a697972641cc437b2 100644 (file)
--- a/keyboard/planck/README.md
+++ b/keyboard/planck/README.md
@@ -1,24 +1,31 @@
 Planck keyboard firmware
 ======================
-DIY/Assembled compact ortholinear keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
+DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
 
-## Notable TMK forks (which some of the keymap files are from)
-- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
-- [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
-- [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
-- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)
+## Quantum MK Firmware
+
+For the full Quantum feature list, see [the parent README.md](/README.md).
 
-## Build
-Move to this directory then just run `make` like:
+## Building
 
-    $ make
+Download or clone the whole firmware and navigate to the keyboard/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. 
 
-Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.
+Depending on which keymap you would like to use, you will have to compile slightly differently.
 
+### Default
+To build with the default keymap, simply run `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.
+### Other Keymaps
+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.
 
-To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
+To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
+```
+$ make KEYMAP=[default|jack|<name>]
+```
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
 
-    $ make KEYMAP=[<name>]
+### Notable forks (which some of the keymap files are from)
+- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
+- [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
+- [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
+- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)