[Keyboard] Initial refactor of maxipad to conform to current standards (#5233)

[qmk_firmware.git] / keyboards / maxipad / readme.md

diff --git a/keyboards/maxipad/readme.md b/keyboards/maxipad/readme.md
index 606bacd75db98fd0cace08100e0bdc704b053fdb..65661b065b3d68e2248913869032154c0c9ae858 100644 (file)
--- a/keyboards/maxipad/readme.md
+++ b/keyboards/maxipad/readme.md
@@ -1,51 +1,27 @@
-<<<<<<< HEAD
-Maxipad keyboard firmware
-======================
+# 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).
-=======
-## Quantum MK Firmware
+5 x 6 Gamepad/Macropad PCBs from /u/wootpatoot
 
-For the full Quantum feature list, see [the parent readme](/).
+- 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
 
->>>>>>> a06115df19a74d39b08758472b221e630c3680d3
+Keyboard Maintainer: QMK Community  
+Hardware Supported: Maxipad PCB  
+Hardware Availability: [switchtop](http://www.switchtop.com/product/gamepad-macropad-pcbs)
 
-## Building
+Make example for this keyboard (after setting up your build environment):
 
-If you are using a pro micro then make sure to enable USE_PRO_MICRO in the makefile
+    make maxipad:default
 
-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. 
+If you would like to use one of the alternative controllers:
 
-Depending on which keymap you would like to use, you will have to compile slightly differently.
+    make maxipad/promicro:default
+    make maxipad/teensy2:default
 
-### Default
-<<<<<<< HEAD
-To build with the default keymap, simply run `make default`.
-=======
-
-To build with the default keymap, simply run `make`.
-
->>>>>>> a06115df19a74d39b08758472b221e630c3680d3
-
-### 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.
-
-<<<<<<< HEAD
-=======
-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.
-
->>>>>>> a06115df19a74d39b08758472b221e630c3680d3
-To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
-
-```
-$ make [default|jack|<name>]
-```
-<<<<<<< HEAD
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
-=======
-
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
-
->>>>>>> a06115df19a74d39b08758472b221e630c3680d3
+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).