aboutsummaryrefslogtreecommitdiff
path: root/keyboards/hhkb/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/hhkb/readme.md')
-rw-r--r--keyboards/hhkb/readme.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/keyboards/hhkb/readme.md b/keyboards/hhkb/readme.md
index 39d49b32a..367c0a08f 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
168Depending on which keymap you would like to use, you will have to compile slightly differently. 168Depending on which keymap you would like to use, you will have to compile slightly differently.
169 169
170### Default 170### Default
171To build with the default keymap, simply run `make`. 171To build with the default keymap, simply run `make default`.
172 172
173### Other Keymaps 173### Other Keymaps
174Several 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. 174Several 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.
175 175
176To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like: 176To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
177
177``` 178```
178$ make KEYMAP=[default|jack|<name>] 179$ make [default|jack|<name>]
179``` 180```
181
180Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. 182Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.