summaryrefslogtreecommitdiff
path: root/keyboards/mini_ten_key_plus/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mini_ten_key_plus/readme.md')
-rw-r--r--keyboards/mini_ten_key_plus/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/mini_ten_key_plus/readme.md b/keyboards/mini_ten_key_plus/readme.md
new file mode 100644
index 0000000000..12afcc4f12
--- /dev/null
+++ b/keyboards/mini_ten_key_plus/readme.md
@@ -0,0 +1,24 @@
+# mini_ten_key_plus
+
+![mini_ten_key_plus](https://imgur.com/QtFFONgl.jpg)
+
+A 5x5 numpad/macropad, with support for a rotary encoder running on a Pro Micro.
+
+* Keyboard Maintainer: [minibois](https://github.com/minibois)
+* Hardware Supported: mini_ten_key_plus PCB, Pro Micro (or equivalent), 3D printed case, 22 - 25 MX (like) switches, PCB mount stabilizers
+* Hardware Availability: https://github.com/minibois/ten-key-plus
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mini_ten_key_plus:default
+
+Flashing example for this keyboard:
+
+ make mini_ten_key_plus: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).
+
+## Bootloader
+
+Enter the bootloader:
+* **Physical reset button**: Briefly press the button on the back of the PCB