summaryrefslogtreecommitdiffstats
path: root/keyboards/maxipad/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/maxipad/readme.md')
-rw-r--r--keyboards/maxipad/readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/maxipad/readme.md b/keyboards/maxipad/readme.md
index e722b66022..1971ce1f36 100644
--- a/keyboards/maxipad/readme.md
+++ b/keyboards/maxipad/readme.md
@@ -3,7 +3,11 @@ maxipad keyboard firmware
## Quantum MK Firmware
+<<<<<<< HEAD
For the full Quantum feature list, see [the parent readme](/).
+=======
+For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
+>>>>>>> bce6e52391da7c5f620c96a91857940f0dee19df
## Building
@@ -13,12 +17,17 @@ Depending on which keymap you would like to use, you will have to compile slight
### Default
+<<<<<<< HEAD
To build with the default keymap, simply run `make default`.
+=======
+To build with the default keymap, simply run `make`.
+>>>>>>> bce6e52391da7c5f620c96a91857940f0dee19df
### 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.
+<<<<<<< HEAD
To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
```
@@ -26,3 +35,12 @@ $ make [default|jack|<name>]
```
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
+=======
+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/`
+>>>>>>> bce6e52391da7c5f620c96a91857940f0dee19df