X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=keyboards%2Fmaxipad%2Freadme.md;h=b62afdf34315f1836d5bdc1c2eae9e64b5a9148d;hb=ea7bb624de0b397c3055b9b879e0d5a9c0a237d6;hp=de2265d1115037f5c02464d9c48780abfbf6b12d;hpb=e14b0e8e7e37116d65f489e6f6ece72c39a603cd;p=qmk_firmware.git diff --git a/keyboards/maxipad/readme.md b/keyboards/maxipad/readme.md index de2265d11..b62afdf34 100644 --- a/keyboards/maxipad/readme.md +++ b/keyboards/maxipad/readme.md @@ -1,30 +1,17 @@ -## Quantum MK Firmware - -For the full Quantum feature list, see [the parent readme](/). +# Maxipad +## Quantum MK Firmware -## Building +For the full Quantum feature list, see [the parent readme.md](/readme.md). +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. - 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`. - +To build with the default keymap, simply run `make maxipad: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|] -``` - -Keymaps follow the format **__\.c__** and are stored in the `keymaps` folder. - +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 `.c` and see keymap document (you can find in top readme.md) and existent keymap files.