]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Fix the keyboard template with new make syntax
authorFred Sundvik <fsundvik@gmail.com>
Sat, 27 Aug 2016 20:29:37 +0000 (23:29 +0300)
committerFred Sundvik <fsundvik@gmail.com>
Sat, 27 Aug 2016 20:31:15 +0000 (23:31 +0300)
Also add proper link to the parent

quantum/template/readme.md

index b2fb4dd98d2891932f2b15cdda88fc0b99bb78aa..b16f4cd76836b0da7be976173eebee329bb4fe35 100644 (file)
@@ -3,7 +3,7 @@
 
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
+For the full Quantum feature list, see [the parent readme](/).
 
 ## Building
 
@@ -13,16 +13,16 @@ Depending on which keymap you would like to use, you will have to compile slight
 
 ### Default
 
-To build with the default keymap, simply run `make`.
+To build with the default keymap, simply run `make default`.
 
 ### 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 a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files.
 
-To build the firmware binary hex file with a keymap just do `make` with `keymap` option like:
+To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
 
 ```
-$ make keymap=[default|jack|<name>]
+$ make [default|jack|<name>]
 ```
 
-Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`
\ No newline at end of file
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.