diff options
| author | Daniel <danielallendeutsch@gmail.com> | 2016-08-31 22:15:47 -0600 |
|---|---|---|
| committer | Daniel <danielallendeutsch@gmail.com> | 2016-08-31 22:15:47 -0600 |
| commit | dbac9f495469854fb64a424b171235e46161d799 (patch) | |
| tree | 8c1b5d5b6e287fdedc5092383333b2ddb44bc4f4 /quantum/template/readme.md | |
| parent | 8019a074cfe39e2bf04c35bb5fb40c9ff9cda9a4 (diff) | |
| parent | e28d151a8a1d458f3c18897c6095decc17b0c3a1 (diff) | |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'quantum/template/readme.md')
| -rw-r--r-- | quantum/template/readme.md | 10 |
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. |