summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/woodpad/readme.md
diff options
context:
space:
mode:
authordrashna <drashna@live.com>2017-09-29 14:52:37 -0700
committerJack Humbert <jack.humb@gmail.com>2017-09-29 11:52:37 -1000
commitd28fb63fac9c10cdec3703b205c3f1a30643c771 (patch)
treefde322de02ef3e584b40de944ad52a9949912d75 /keyboards/handwired/woodpad/readme.md
parent6ec7ccec63a5f434af3b6d5726fac858adfdbb61 (diff)
updated drashna's keymaps (#1769)
* Add woodpad * Cleanup * Remove misc layouts for woodpad * Move woodpad to handwired * Updated RGB Underglow info
Diffstat (limited to 'keyboards/handwired/woodpad/readme.md')
-rw-r--r--keyboards/handwired/woodpad/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/handwired/woodpad/readme.md b/keyboards/handwired/woodpad/readme.md
new file mode 100644
index 0000000000..2697398c96
--- /dev/null
+++ b/keyboards/handwired/woodpad/readme.md
@@ -0,0 +1,28 @@
+woodpad keyboard firmware
+======================
+
+## Quantum MK Firmware
+
+For the full Quantum feature list, see [the parent readme](/).
+
+## Building
+
+Download or clone the whole firmware and navigate to the keyboards/woodpad 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 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 a keymap like this:
+
+```
+$ make [default|jack|<name>]
+```
+
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.