aboutsummaryrefslogtreecommitdiffstats
path: root/quantum/template/readme.md
diff options
context:
space:
mode:
authorGravatar Jack Humbert <jack.humb@gmail.com>2016-06-23 22:18:20 -0400
committerGravatar GitHub <noreply@github.com>2016-06-23 22:18:20 -0400
commit13bb6b4b7fdd2b3e419d0f89c93fb980b00eeb9b (patch)
tree2777e5c95bad3f5a9773fc58524a6ad99df63738 /quantum/template/readme.md
parentba116ceb496011bb35ce074a3ba8c2448f059260 (diff)
downloadqmk_firmware-13bb6b4b7fdd2b3e419d0f89c93fb980b00eeb9b.tar.gz
Backlight abstraction and other changes (#439)
* redoes matrix pins, abstracts backlight code for B5,6,7 * slimming down keyboard stuff, backlight breathing implemented * don't call backlight init when no pin * cleans up user/kb/quantum calls, keyboard files * fix pvc atomic * replaces CHANNEL with correct var in breathing * removes .hexs, updates readmes, updates template * cleans-up clueboards, readmes to lowercase * updates readme
Diffstat (limited to 'quantum/template/readme.md')
-rw-r--r--quantum/template/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/quantum/template/readme.md b/quantum/template/readme.md
new file mode 100644
index 000000000..b2fb4dd98
--- /dev/null
+++ b/quantum/template/readme.md
@@ -0,0 +1,28 @@
+%KEYBOARD% 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/%KEYBOARD% 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/` \ No newline at end of file