summaryrefslogtreecommitdiff
path: root/keyboards/cluecard/readme.md
diff options
context:
space:
mode:
authorToni2016-08-13 09:24:24 +0200
committerToni2016-08-13 09:24:24 +0200
commite0aa2169055f554a3cb87208b1e73a6b2707405b (patch)
tree6c74a1f7284f385b99a231ef0c1c805fab1083e5 /keyboards/cluecard/readme.md
parentcafa528b88c097f02ae92a5b15b015f5653cefe7 (diff)
parent098951905d527c19043de75ef262ac9679ec452b (diff)
Merge remote-tracking branch 'origin/master' into iso_split_rshift
update from Upstream
Diffstat (limited to 'keyboards/cluecard/readme.md')
-rw-r--r--keyboards/cluecard/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/cluecard/readme.md b/keyboards/cluecard/readme.md
new file mode 100644
index 000000000..ae1afbbfd
--- /dev/null
+++ b/keyboards/cluecard/readme.md
@@ -0,0 +1,28 @@
+cluecard keyboard firmware
+======================
+
+## Quantum MK Firmware
+
+For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
+
+## Building
+
+Download or clone the whole firmware and navigate to the keyboards/cluecard folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
+
+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`.
+
+### 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:
+
+```
+$ make keymap=[default|jack|<name>]
+```
+
+Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`