summaryrefslogtreecommitdiff
path: root/quantum
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2016-08-27 17:07:49 -0400
committerGitHub <noreply@github.com>2016-08-27 17:07:49 -0400
commita1b289c99aaf28373f9eca73853bba24b5c2f813 (patch)
tree787b9c821a5c1f1d8e0c0bcee545f74192b854e0 /quantum
parent4fd5ac8326f491a347b8c049f32a3353a633ebf5 (diff)
parent1f5838a28679975f689e35471a35720ed5c7e7c5 (diff)
Merge pull request #694 from fredizzimo/keyboard_template
Fix the keyboard template with new make syntax
Diffstat (limited to 'quantum')
-rw-r--r--quantum/template/readme.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/quantum/template/readme.md b/quantum/template/readme.md
index b2fb4dd98d..b16f4cd768 100644
--- a/quantum/template/readme.md
+++ b/quantum/template/readme.md
@@ -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.