diff options
| author | Erovia <Erovia@users.noreply.github.com> | 2020-10-25 15:23:42 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-25 15:23:42 +0000 |
| commit | ad86894ae7d5fbb7aed697d9f576cd186bfd1c9c (patch) | |
| tree | c5ffe570301b95699d93566d5b9453bda203a7ae /keyboards/mechmini/v2/readme.md | |
| parent | af455a8368dc564df51f9657b04932956ccf580b (diff) | |
Rename keyboard-level readmes to lower-case (#10759)
This is the recommendation in the [PR
Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it
will make working with them easier in the CLI/API/etc.
Diffstat (limited to 'keyboards/mechmini/v2/readme.md')
| -rw-r--r-- | keyboards/mechmini/v2/readme.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/mechmini/v2/readme.md b/keyboards/mechmini/v2/readme.md new file mode 100644 index 0000000000..fdc9fef9bf --- /dev/null +++ b/keyboards/mechmini/v2/readme.md @@ -0,0 +1,22 @@ +Mechmini 2.0 +============ + +A 40% compact ortholinear/staggered keyboard. + +Version 2 (Mechmini 2.0) was shipped powered by QMK [More info on MECHKEYS](https://mechkeys.ca). + +Keyboard Maintainer: [TurboMech](https://github.com/TurboMech) + +Hardware Supported: Mechmini 2.0 keyboard + +Hardware Availability: [MECHKEYS Mechmini 2.0](https://mechkeys.ca/collections/keyboards/products/mechmini-2-0) + +Make example for this keyboard (after setting up your build environment), this will make the Mechmini 2.0 default keymap (split space): + + make mechmini/v2:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. + +## Mechmini Notes + +There are 2 versions of the Mechmini keyboard. Please read the readme for the version you have for make instructions. |