summaryrefslogtreecommitdiffstats
path: root/keyboards/preonic/readme.md
diff options
context:
space:
mode:
authorOlivier <olivier@gid0.org>2016-11-27 23:23:21 +0100
committerOlivier <olivier@gid0.org>2016-11-27 23:23:21 +0100
commitd6d0b7eadaa568853b21d74057db306a33b7a847 (patch)
treee935179ed0db152f94d31ef187c01a40f0fb42d6 /keyboards/preonic/readme.md
parent73d2a470eed73a1ba28520343bd1cfc81498d183 (diff)
parent1585fc4b616cb28b8d4a418cd31c8ce0dd64f731 (diff)
downloadqmk_firmware-d6d0b7eadaa568853b21d74057db306a33b7a847.tar.gz
qmk_firmware-d6d0b7eadaa568853b21d74057db306a33b7a847.tar.xz
Merge https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/preonic/readme.md')
-rw-r--r--keyboards/preonic/readme.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/keyboards/preonic/readme.md b/keyboards/preonic/readme.md
index f0be255a0..10763ee97 100644
--- a/keyboards/preonic/readme.md
+++ b/keyboards/preonic/readme.md
@@ -13,13 +13,15 @@ Download or clone the whole firmware and navigate to the keyboards/preonic folde
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.