summaryrefslogtreecommitdiff
path: root/keyboards/kiwikeebs/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kiwikeebs/readme.md')
-rw-r--r--keyboards/kiwikeebs/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/kiwikeebs/readme.md b/keyboards/kiwikeebs/readme.md
new file mode 100644
index 0000000000..61a1441bd7
--- /dev/null
+++ b/keyboards/kiwikeebs/readme.md
@@ -0,0 +1,19 @@
+# KiwiKeebs MacroBoard V1.0
+
+![KiwiKeebs](https://i.imgur.com/h5i9jBl.png)
+
+A 6 Key PCB with Rotary Encoder Knob + Button made from solid CNC aluminium.
+
+* Keyboard Maintainer: [AKiwi92](https://github.com/akiwi92)
+* Hardware Supported: KiwiKeebs MacroBoard V1.0
+* Hardware Availability: [reddit.com](https://www.reddit.com/r/mechmarket/comments/ibijrd/ic_kiwikeebs_6key_macroboard_rotary_encoder_diy/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kiwikeebsmacro:default
+
+Flashing example for this keyboard:
+
+ make kiwikeebsmacro: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).