소스 검색

Fix the keyboard template with new make syntax

Also add proper link to the parent
Fred Sundvik 9 년 전
부모
커밋
1f5838a286
1개의 변경된 파일5개의 추가작업 그리고 5개의 파일을 삭제
  1. 5 5
      quantum/template/readme.md

+ 5 - 5
quantum/template/readme.md

@@ -3,7 +3,7 @@
 
 
 ## Quantum MK Firmware
 ## 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
 ## Building
 
 
@@ -13,16 +13,16 @@ Depending on which keymap you would like to use, you will have to compile slight
 
 
 ### Default
 ### Default
 
 
-To build with the default keymap, simply run `make`.
+To build with the default keymap, simply run `make default`.
 
 
 ### Other Keymaps
 ### 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.
 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/`
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.