summaryrefslogtreecommitdiffstats
path: root/keyboards/atomic/readme.md
diff options
context:
space:
mode:
authorCallum Oakley <c.oakley108@gmail.com>2016-09-01 17:55:00 +0100
committerCallum Oakley <c.oakley108@gmail.com>2016-09-01 17:55:00 +0100
commit9c3193f22555119eb15f63f5ae5efe45e6d7358c (patch)
treea0dcfb3ed442c12a66b444c4c579711660c30657 /keyboards/atomic/readme.md
parent993d72b11fca8d50296570dc85e9354f8045c4a6 (diff)
parente28d151a8a1d458f3c18897c6095decc17b0c3a1 (diff)
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'keyboards/atomic/readme.md')
-rw-r--r--keyboards/atomic/readme.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/keyboards/atomic/readme.md b/keyboards/atomic/readme.md
index ab1e7ba1ff..674dcf113b 100644
--- a/keyboards/atomic/readme.md
+++ b/keyboards/atomic/readme.md
@@ -13,13 +13,14 @@ Download or clone the whole firmware and navigate to the keyboards/atomic 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.