summaryrefslogtreecommitdiff
path: root/keyboards/atreus/readme.md
diff options
context:
space:
mode:
authorIBNobody <ibnobody@gmail.com>2016-08-28 18:50:06 -0500
committerIBNobody <ibnobody@gmail.com>2016-08-28 18:50:06 -0500
commit6da0eb2b2b70d7b2c5bb1f7c6898f7d9a275ceea (patch)
tree50cd382df7dac58057c958f62732174cf0dfe920 /keyboards/atreus/readme.md
parent9263ade0fbdde6431fb5c7f26970754c5c7c2963 (diff)
parent6d1e916851daa7bcbd8ef31b6fbc73cb369ef1f0 (diff)
Merge remote-tracking branch 'refs/remotes/jackhumbert/master'
Diffstat (limited to 'keyboards/atreus/readme.md')
-rw-r--r--keyboards/atreus/readme.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/keyboards/atreus/readme.md b/keyboards/atreus/readme.md
index 734f58f0f0..a4077668e3 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.