aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/kiwikeebs/readme.md
diff options
context:
space:
mode:
authorAKiwi92 <69772382+AKiwi92@users.noreply.github.com>2020-08-25 04:36:05 +0100
committerGitHub <noreply@github.com>2020-08-24 20:36:05 -0700
commitecb212106950d4ffc5dca64fc06f031b6b12fcc1 (patch)
tree85083d03df7b6bce636a62f10f313676c79eb930 /keyboards/kiwikeebs/readme.md
parent1272371f157f9730013981ada600d994612378aa (diff)
downloadfirmware-ecb212106950d4ffc5dca64fc06f031b6b12fcc1.tar.gz
firmware-ecb212106950d4ffc5dca64fc06f031b6b12fcc1.tar.bz2
firmware-ecb212106950d4ffc5dca64fc06f031b6b12fcc1.zip
[Keyboard] KiwiKeebs MacroBoard v1.0 (#10080)
* KiwiKeebs v.10 QMK * Rename files and folder structure for QMK pull request * Deleted unused files * Added starter keymap * Changes to make pull request compliant * Removed lines for PR error * Error fix in json for PR * Update keyboards/kiwikeebsmacro/kiwikeebsmacro.h * Update keyboards/kiwikeebsmacro/readme.md * Update keyboards/kiwikeebsmacro/keymaps/default/readme.md * Update keyboards/kiwikeebsmacro/keymaps/default/keymap.c * Update keyboards/kiwikeebsmacro/info.json * Update keyboards/kiwikeebsmacro/keymaps/default/keymap.c * Update keyboards/kiwikeebsmacro/config.h * Changed structure to allow for future boards * Update keyboards/kiwikeebs/macro/config.h * Update keyboards/kiwikeebs/macro/info.json * Update keyboards/kiwikeebs/macro/keymaps/default/keymap.c * Update keyboards/kiwikeebs/macro/keymaps/default/keymap.c * Amended rotarty to use kb instead of user * Updated structure after pull request commits * Update keyboards/kiwikeebs/macro/config.h * Update keyboards/kiwikeebs/macro/info.json
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 000000000..61a1441bd
--- /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).