summaryrefslogtreecommitdiffstats
path: root/keyboards/cluecard/readme.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2016-08-27 13:49:42 -0400
committerGitHub <noreply@github.com>2016-08-27 13:49:42 -0400
commit36b6a96596e6cbca879d5304a586e279c15b04a9 (patch)
tree7fdd6b9084f06e5126516ac61756120e1ce1eb63 /keyboards/cluecard/readme.md
parent2c8f6557e6994d3fe4fa2038f6cb4a4e51caf3a9 (diff)
parent265df7d5da5ead27bef3d00fce7d0f2bf133e9cc (diff)
Merge pull request #666 from fredizzimo/makefile_overhaul
Makefile overhaul
Diffstat (limited to 'keyboards/cluecard/readme.md')
-rw-r--r--keyboards/cluecard/readme.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/keyboards/cluecard/readme.md b/keyboards/cluecard/readme.md
index ae1afbbfdd..be13fc0171 100644
--- a/keyboards/cluecard/readme.md
+++ b/keyboards/cluecard/readme.md
@@ -13,16 +13,16 @@ Depending on which keymap you would like to use, you will have to compile slight
### 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 folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant 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 **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`