diff options
Diffstat (limited to 'keyboards/maxipad/readme.md')
| -rw-r--r-- | keyboards/maxipad/readme.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/keyboards/maxipad/readme.md b/keyboards/maxipad/readme.md index ab7b122fe8..861ea2b078 100644 --- a/keyboards/maxipad/readme.md +++ b/keyboards/maxipad/readme.md @@ -1,9 +1,11 @@ -## Quantum MK Firmware +Maxipad keyboard firmware -For the full Quantum feature list, see [the parent readme](/). +## Quantum MK Firmware +For the full Quantum feature list, see [the parent readme.md](/readme.md). -## Building +If you are using a pro micro then make sure to enable USE_PRO_MICRO in the makefile +Change the config.h pinout to match your mcu!! 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. @@ -15,8 +17,8 @@ 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 file named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files. -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: @@ -25,4 +27,3 @@ $ make [default|jack|<name>] ``` Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. - |