From ad86894ae7d5fbb7aed697d9f576cd186bfd1c9c Mon Sep 17 00:00:00 2001 From: Erovia Date: Sun, 25 Oct 2020 15:23:42 +0000 Subject: 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. --- keyboards/mechmini/v1/README.md | 19 ------------------- keyboards/mechmini/v1/readme.md | 19 +++++++++++++++++++ keyboards/mechmini/v2/README.md | 22 ---------------------- keyboards/mechmini/v2/readme.md | 22 ++++++++++++++++++++++ 4 files changed, 41 insertions(+), 41 deletions(-) delete mode 100644 keyboards/mechmini/v1/README.md create mode 100644 keyboards/mechmini/v1/readme.md delete mode 100644 keyboards/mechmini/v2/README.md create mode 100644 keyboards/mechmini/v2/readme.md (limited to 'keyboards/mechmini') diff --git a/keyboards/mechmini/v1/README.md b/keyboards/mechmini/v1/README.md deleted file mode 100644 index 902948c24d..0000000000 --- a/keyboards/mechmini/v1/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Mechmini V1 - -A 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). - -* Keyboard Maintainer: QMK Community -* Hardware Supported: Mechmini 1 PCB -* Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca) - -Make example for this keyboard (after setting up your build environment): - - make mechmini/v1:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make mechmini/v1:default:flash - -**Reset Key**: Hold down the key commonly programmed as *L_Ctrl* while plugging in the keyboard. - -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). diff --git a/keyboards/mechmini/v1/readme.md b/keyboards/mechmini/v1/readme.md new file mode 100644 index 0000000000..902948c24d --- /dev/null +++ b/keyboards/mechmini/v1/readme.md @@ -0,0 +1,19 @@ +# Mechmini V1 + +A 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). + +* Keyboard Maintainer: QMK Community +* Hardware Supported: Mechmini 1 PCB +* Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca) + +Make example for this keyboard (after setting up your build environment): + + make mechmini/v1:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make mechmini/v1:default:flash + +**Reset Key**: Hold down the key commonly programmed as *L_Ctrl* while plugging in the keyboard. + +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). diff --git a/keyboards/mechmini/v2/README.md b/keyboards/mechmini/v2/README.md deleted file mode 100644 index fdc9fef9bf..0000000000 --- a/keyboards/mechmini/v2/README.md +++ /dev/null @@ -1,22 +0,0 @@ -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. 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. -- cgit v1.2.3