X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=keyboards%2Fmaxipad%2Freadme.md;h=65661b065b3d68e2248913869032154c0c9ae858;hb=36fce12d080a4dd37a00f504396bd94b7a06e203;hp=ab7b122fe88cf7f70388dc6dec39a07618a9b3be;hpb=b493f6a4ed14e74c268ae3d7a07577591fe71cc7;p=qmk_firmware.git diff --git a/keyboards/maxipad/readme.md b/keyboards/maxipad/readme.md index ab7b122fe..65661b065 100644 --- a/keyboards/maxipad/readme.md +++ b/keyboards/maxipad/readme.md @@ -1,28 +1,27 @@ -## Quantum MK Firmware +# Maxipad -For the full Quantum feature list, see [the parent readme](/). +![Maxipad](https://images.bigcartel.com/product_images/193297217/product_image.jpg) +5 x 6 Gamepad/Macropad PCBs from /u/wootpatoot -## Building +- Multiple layouts supported + - Full-grid + - 2u thumb-key (the 2u only works in the bottom right position). +- Multiple controllers supported + - Pro Micro + - PJRC Teensy 2.0 -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. +Keyboard Maintainer: QMK Community +Hardware Supported: Maxipad PCB +Hardware Availability: [switchtop](http://www.switchtop.com/product/gamepad-macropad-pcbs) -Depending on which keymap you would like to use, you will have to compile slightly differently. +Make example for this keyboard (after setting up your build environment): -### Default + make maxipad:default -To build with the default keymap, simply run `make`. +If you would like to use one of the alternative controllers: + make maxipad/promicro:default + make maxipad/teensy2: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. - +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).