summaryrefslogtreecommitdiff
path: root/keyboards/mechmini
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-08-16 15:08:16 -0700
committerJack Humbert <jack.humb@gmail.com>2017-08-16 20:36:59 -0400
commit4e73b0b8d7750bcddc445b5a52008d4c6cea977d (patch)
treee6c54f5d0b334f1e0acc41b6406e8b26900f80b0 /keyboards/mechmini
parent2ee0dc7793165eacfe7ee2a4994d557294988f18 (diff)
Make the bulk of our keyboards match the readme.md standard
Diffstat (limited to 'keyboards/mechmini')
-rw-r--r--keyboards/mechmini/README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/keyboards/mechmini/README.md b/keyboards/mechmini/README.md
index 72743319fa..ed590f3f1b 100644
--- 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