summaryrefslogtreecommitdiffstats
path: root/keyboards/maxipad/readme.md
diff options
context:
space:
mode:
authorclimbalima <climbalima@gmail.com>2016-11-17 01:18:54 +0100
committerclimbalima <climbalima@gmail.com>2016-11-17 01:18:54 +0100
commit1dd6ceb45dfcf5f0991b84fea5a761a35df7fcda (patch)
tree32632c8ce4a149566091f9edf3992c796716daf8 /keyboards/maxipad/readme.md
parent631b8999a737ec73610f8b569b1f775cadf08172 (diff)
downloadqmk_firmware-1dd6ceb45dfcf5f0991b84fea5a761a35df7fcda.tar.gz
qmk_firmware-1dd6ceb45dfcf5f0991b84fea5a761a35df7fcda.tar.xz
Updated my repo to current qmk
Diffstat (limited to 'keyboards/maxipad/readme.md')
-rw-r--r--keyboards/maxipad/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/maxipad/readme.md b/keyboards/maxipad/readme.md
new file mode 100644
index 000000000..e722b6602
--- /dev/null
+++ b/keyboards/maxipad/readme.md
@@ -0,0 +1,28 @@
+maxipad 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/maxipad 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.