diff options
| author | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 22:49:13 +0100 |
|---|---|---|
| committer | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 22:49:13 +0100 |
| commit | b49d7800aeae1009b39b2bff2121864425e73ce9 (patch) | |
| tree | f73447fc32940c7bc6b691a83567186d1afbc991 /keyboards/atreus/readme.md | |
| parent | 9ecf9073b96799e52a1f1c0d35b57177382902ce (diff) | |
| parent | ae95834f5af7404c04e6fe3446019046278d814b (diff) | |
| download | qmk_firmware-b49d7800aeae1009b39b2bff2121864425e73ce9.tar.gz qmk_firmware-b49d7800aeae1009b39b2bff2121864425e73ce9.tar.xz | |
Merge remote-tracking branch 'refs/remotes/jackhumbert/master'
Diffstat (limited to 'keyboards/atreus/readme.md')
| -rw-r--r-- | keyboards/atreus/readme.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/keyboards/atreus/readme.md b/keyboards/atreus/readme.md index 734f58f0f..a4077668e 100644 --- a/keyboards/atreus/readme.md +++ b/keyboards/atreus/readme.md @@ -174,13 +174,14 @@ 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 file 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. |