summaryrefslogtreecommitdiffstats
path: root/keyboards/kiwikeebs/macro/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-09-11 04:21:16 +0000
committerQMK Bot <hello@qmk.fm>2021-09-11 04:21:16 +0000
commitf72a358931a8989d007b191e0d254caec07d480f (patch)
treed2975cfda9748e8a006a02dd69523f0293dafe6e /keyboards/kiwikeebs/macro/readme.md
parenta433ce36eb5df9b88d1414cc80c2763bdc78c469 (diff)
parentd0b1d9f548aa39e1d267e8f62db4e0c65aae9206 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/kiwikeebs/macro/readme.md')
-rw-r--r--keyboards/kiwikeebs/macro/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/kiwikeebs/macro/readme.md b/keyboards/kiwikeebs/macro/readme.md
new file mode 100644
index 0000000000..ce9d4ea8cc
--- /dev/null
+++ b/keyboards/kiwikeebs/macro/readme.md
@@ -0,0 +1,19 @@
+# KiwiKeebs MacroBoard V1.0
+
+![KiwiKeebs](https://kiwikeebs.co.uk/wp-content/themes/storefront-child-theme-master/images/kiwikeebs-logo.svg)
+
+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 kiwikeebs/macro:default
+
+Flashing example for this keyboard:
+
+ make kiwikeebs/macro: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).