summaryrefslogtreecommitdiff
path: root/keyboards/kbdfans/niu_mini/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kbdfans/niu_mini/readme.md')
-rw-r--r--keyboards/kbdfans/niu_mini/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/kbdfans/niu_mini/readme.md b/keyboards/kbdfans/niu_mini/readme.md
new file mode 100644
index 0000000000..1a91ece94b
--- /dev/null
+++ b/keyboards/kbdfans/niu_mini/readme.md
@@ -0,0 +1,19 @@
+# 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/products/niu-mini-40-diy-kit)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kbdfans/niu_mini: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 kbdfans/niu_mini: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).