aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/atreus/readme.md
diff options
context:
space:
mode:
authorGravatar Jason Janse van Rensburg <l33tjas.0n@gmail.com>2016-08-30 14:54:00 +0200
committerGravatar Jason Janse van Rensburg <l33tjas.0n@gmail.com>2016-08-30 14:54:00 +0200
commitfc2ca62a3b9552175eb7c27cc11f3a5af6cfae50 (patch)
tree59b2f2406f472a9fd2af4946420d1a1c880929c0 /keyboards/atreus/readme.md
parenta41a7a9100b9f4c6bfdf49b39b05e626ffd95397 (diff)
parent8e00c464e6f488d86e0768a77a2ad5ee238dba6d (diff)
downloadqmk_firmware-fc2ca62a3b9552175eb7c27cc11f3a5af6cfae50.tar.gz
Merge branch 'master'
Conflicts: keyboards/planck/keymaps/bone2planck/keymap.c
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 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.