diff options
| author |  Fred Sundvik <fsundvik@gmail.com> | 2016-08-20 03:22:16 +0300 |
|---|---|---|
| committer | Fred Sundvik <fsundvik@gmail.com> | 2016-08-20 03:56:48 +0300 |
| commit | da226e61261e0c11e678d2086c00b2a45726083e (patch) | |
| tree | 3157d1db1b8f35782e25533e62a0b46bcb42fc99 /keyboards/hhkb/readme.md | |
| parent | b4c75569b0bc2f3ba9a7766ab64ff504fad3836e (diff) | |
| download | qmk_firmware-da226e61261e0c11e678d2086c00b2a45726083e.tar.gz | |
Update keyboard readme files with new makefile instructions
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 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 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. |