summaryrefslogtreecommitdiff
path: root/keyboards/minim/readme.md
diff options
context:
space:
mode:
authorMatthew Dias <matthewdias@me.com>2020-11-25 10:57:58 -0600
committerGitHub <noreply@github.com>2020-11-25 08:57:58 -0800
commit24a741649d898d2bd84a581646d11e4e3a3b4f91 (patch)
tree51b0935b9e0a16b1c5d041a8f87810226ec1cebd /keyboards/minim/readme.md
parent0a9476bc2afbe19caef4429a3a9b6e18e006d07e (diff)
[Keyboard] Add minim keyboard (#10970)
* Create minim firmware * Cleanup and add configurator support * PR Checklist Items * Delete keymap.c * Apply suggestions from code review Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'keyboards/minim/readme.md')
-rw-r--r--keyboards/minim/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/minim/readme.md b/keyboards/minim/readme.md
new file mode 100644
index 0000000000..95820c4db9
--- /dev/null
+++ b/keyboards/minim/readme.md
@@ -0,0 +1,21 @@
+# minim
+
+![](https://raw.githubusercontent.com/matthewdias/minim/main/layout.png)
+
+A symmetrical 50% keyboard.
+
+* Keyboard Maintainer: matthewdias
+* Hardware Supported: minim PCB
+* Hardware Availability: [GitHub](https://github.com/matthewdias/minim)
+
+To reset the keyboard into bootloader mode, press the reset switch on the underside.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make minim:default
+
+Flashing example for this keyboard ([using the command line](https://docs.qmk.fm/#/newbs_flashing?id=flash-your-keyboard-from-the-command-line)):
+
+ make minim:default:flash
+
+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).