diff options
| author | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 13:49:13 -0800 |
|---|---|---|
| committer | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 13:49:13 -0800 |
| commit | b49d7800aeae1009b39b2bff2121864425e73ce9 (patch) | |
| tree | f73447fc32940c7bc6b691a83567186d1afbc991 /keyboards/hhkb/readme.md | |
| parent | 9ecf9073b96799e52a1f1c0d35b57177382902ce (diff) | |
| parent | ae95834f5af7404c04e6fe3446019046278d814b (diff) | |
Merge remote-tracking branch 'refs/remotes/jackhumbert/master'
Diffstat (limited to 'keyboards/hhkb/readme.md')
| -rw-r--r-- | keyboards/hhkb/readme.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/keyboards/hhkb/readme.md b/keyboards/hhkb/readme.md index 39d49b32a1..367c0a08f7 100644 --- a/keyboards/hhkb/readme.md +++ b/keyboards/hhkb/readme.md @@ -168,13 +168,15 @@ Download or clone the whole firmware and navigate to the keyboards/planck folder 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`. +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 file in the keymaps folder named `<name>.c` and see keymap document (you can find in top readme.md) and existent 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 **__\<name\>.c__** and are stored in the `keymaps` folder. |