summaryrefslogtreecommitdiffstats
path: root/keyboards/niu_mini/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/niu_mini/readme.md')
-rw-r--r--keyboards/niu_mini/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/niu_mini/readme.md b/keyboards/niu_mini/readme.md
new file mode 100644
index 000000000..71bfae273
--- /dev/null
+++ b/keyboards/niu_mini/readme.md
@@ -0,0 +1,16 @@
+NIU Mini
+===
+
+![NIU Mini](https://cdn.shopify.com/s/files/1/1473/3902/files/40__01.jpg)
+
+A compact 40% (12x4) ortholinear keyboard kit sold by KBDFans.
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: NIU Mini PCB
+Hardware Availability: [KBDFans](https://kbdfans.myshopify.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make niu_mini:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.