summaryrefslogtreecommitdiff
path: root/keyboards/winkeys/mini_winni/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/winkeys/mini_winni/readme.md')
-rw-r--r--keyboards/winkeys/mini_winni/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/winkeys/mini_winni/readme.md b/keyboards/winkeys/mini_winni/readme.md
new file mode 100644
index 0000000000..e7c43995c0
--- /dev/null
+++ b/keyboards/winkeys/mini_winni/readme.md
@@ -0,0 +1,22 @@
+# Mini Winni
+
+A 2x4 Macropad by WinKeys
+
+- Keyboard Maintainer: [matthewdias](https://github.com/matthewdias)
+- Hardware Supported: mini winni PCB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make winkeys/mini_winni:default
+
+Flashing example for this keyboard:
+
+ make winkeys/mini_winni: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 (or short the reset/ground pads, should a tactile button not be installed)