reforked master and added changes to 7u and 6u iso layouts

[qmk_firmware.git] / keyboards / mechmini / README.md

diff --git a/keyboards/mechmini/README.md b/keyboards/mechmini/README.md
index 72743319fa5b22b04f8af094e5c008bb3f13b663..b95153051c975d13777ec01c7d8b59ccaddaa2aa 100644 (file)
--- a/keyboards/mechmini/README.md
+++ b/keyboards/mechmini/README.md
@@ -1,16 +1,24 @@
-mechmini keyboard firmware
-==========================
+mechmini
+========
 
-This is a port of the QMK firmware for boards that are based on the
-ps2avrGB firmware, like the [ps2avrGB
-keyboard](https://www.keyclack.com/product/gb-ps2avrgb/) or the ones sold
-by [Winkeyless](http://winkeyless.kr/product/ps2avrgb-parts/).
+A compact ortholinear/staggered keyboard.
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: mechmini PCB
+Hardware Availability: https://mechkeys.ca/collections/keyboards/products/mechmini-2-0-pcb
+
+Make example for this keyboard (after setting up your build environment):
+
+    make mechmini:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+
+## Mechmini Notes
 
 Note that this is a complete replacement for the firmware, so you won't be
 using Bootmapper Client to change any keyboard settings, since not all the
 USB report options are supported.
 
-
 ## Installing
 
 First, install the requirements. These commands are for OSX, but all you
@@ -32,7 +40,7 @@ Then, with the keyboard plugged in, simply run this command from the
 `qmk_firmware` directory:
 
 ```
-$ make mechmini-program
+$ make mechmini:program
 ```
 
 If you prefer, you can just build it and flash the firmware directly with