aboutsummaryrefslogtreecommitdiff
path: root/keyboards/maxipad/readme.md
diff options
context:
space:
mode:
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..ab7b122fe
--- /dev/null
+++ b/keyboards/maxipad/readme.md
@@ -0,0 +1,28 @@
1## Quantum MK Firmware
2
3For the full Quantum feature list, see [the parent readme](/).
4
5
6## Building
7
8Download 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.
9
10Depending on which keymap you would like to use, you will have to compile slightly differently.
11
12### Default
13
14To build with the default keymap, simply run `make`.
15
16
17### Other Keymaps
18
19Several 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.
20
21To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
22
23```
24$ make [default|jack|<name>]
25```
26
27Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
28