X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=keyboards%2Fcluecard%2Freadme.md;h=be13fc01713cbb21b1c52e653a9addee55358d6f;hb=587b0de6e563fa277c8661f2c5c48070bd004f4f;hp=ae1afbbfddb179364ca070adab7e512430100edf;hpb=009ab77d3e26bd348e45a9a8102b2737c9367979;p=qmk_firmware.git diff --git a/keyboards/cluecard/readme.md b/keyboards/cluecard/readme.md index ae1afbbfd..be13fc017 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|] +$ make [default|jack|] ``` Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`