summaryrefslogtreecommitdiffstats
path: root/keyboards/maxipad/readme.md
diff options
context:
space:
mode:
authorzvecr <git@zvecr.com>2019-02-26 01:07:58 +0000
committerDrashna Jaelre <drashna@live.com>2019-02-25 17:07:58 -0800
commit36fce12d080a4dd37a00f504396bd94b7a06e203 (patch)
tree31024d41f5b410f99603e244ac68466c168edfb8 /keyboards/maxipad/readme.md
parent303859ea284ebd08e305ac1bd907aee399f5a01d (diff)
[Keyboard] Initial refactor of maxipad to conform to current standards (#5233)
Diffstat (limited to 'keyboards/maxipad/readme.md')
-rw-r--r--keyboards/maxipad/readme.md28
1 files changed, 19 insertions, 9 deletions
diff --git a/keyboards/maxipad/readme.md b/keyboards/maxipad/readme.md
index b62afdf343..65661b065b 100644
--- a/keyboards/maxipad/readme.md
+++ b/keyboards/maxipad/readme.md
@@ -1,17 +1,27 @@
# Maxipad
-## Quantum MK Firmware
+![Maxipad](https://images.bigcartel.com/product_images/193297217/product_image.jpg)
-For the full Quantum feature list, see [the parent readme.md](/readme.md).
+5 x 6 Gamepad/Macropad PCBs from /u/wootpatoot
-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!!
+- 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
-Depending on which keymap you would like to use, you will have to compile slightly differently.
+Keyboard Maintainer: QMK Community
+Hardware Supported: Maxipad PCB
+Hardware Availability: [switchtop](http://www.switchtop.com/product/gamepad-macropad-pcbs)
-### Default
+Make example for this keyboard (after setting up your build environment):
-To build with the default keymap, simply run `make maxipad:default`.
+ 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 file named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files.
+If you would like to use one of the alternative controllers:
+
+ make maxipad/promicro:default
+ make maxipad/teensy2:default
+
+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).