aboutsummaryrefslogtreecommitdiff
path: root/keyboards/mechmini/v1/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mechmini/v1/readme.md')
-rw-r--r--keyboards/mechmini/v1/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/mechmini/v1/readme.md b/keyboards/mechmini/v1/readme.md
new file mode 100644
index 000000000..902948c24
--- /dev/null
+++ b/keyboards/mechmini/v1/readme.md
@@ -0,0 +1,19 @@
1# Mechmini V1
2
3A 40% ortholinear/staggered keyboard, that was originally bootmapper and can be ported to QMK following this readme. This version is no longer in production [More info on MECHKEYS](https://mechkeys.ca).
4
5* Keyboard Maintainer: QMK Community
6* Hardware Supported: Mechmini 1 PCB
7* Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca)
8
9Make example for this keyboard (after setting up your build environment):
10
11 make mechmini/v1:default
12
13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14
15 make mechmini/v1:default:flash
16
17**Reset Key**: Hold down the key commonly programmed as *L_Ctrl* while plugging in the keyboard.
18
19See 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).