summaryrefslogtreecommitdiff
path: root/keyboards/keysofkings/twokey/readme.md
diff options
context:
space:
mode:
authorKeys of Kings <keysofkings@gmail.com>2020-11-01 12:53:17 -0600
committerGitHub <noreply@github.com>2020-11-01 10:53:17 -0800
commit76bc23550857badaa35ae68c62875dd8b1fad0ce (patch)
tree42252f3f4c2f6b7d32ddf9dd9b565b6f6e2c662d /keyboards/keysofkings/twokey/readme.md
parentfed9c97ddbd714c3a6981cfeb4534f286b969079 (diff)
[Keyboard] Add keysofkings folder and twokey keyboard (#10754)
* Add keysofkings folder and twokey keyboard * Update readme.md * Update readme.md * Update config.h * Update config.h * Update keymap.c * Update twokey.c * Update twokey.h * Update keyboards/keysofkings/twokey/config.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/keysofkings/twokey/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/keysofkings/twokey/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/keysofkings/twokey/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/keysofkings/twokey/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update info.json * Update keymap.c * Update keyboards/keysofkings/twokey/info.json Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/keysofkings/twokey/readme.md')
-rw-r--r--keyboards/keysofkings/twokey/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/keysofkings/twokey/readme.md b/keyboards/keysofkings/twokey/readme.md
new file mode 100644
index 0000000000..18394f8f80
--- /dev/null
+++ b/keyboards/keysofkings/twokey/readme.md
@@ -0,0 +1,16 @@
+# TWOKEY
+
+![Twokey](https://i.imgur.com/UiLwPldl.jpeg)
+
+A Two Key mini keyboard with Rotary Encoder/Switch along with Backlight keys, RGB Underglow, and Piezo Buzzer. Supports Cherry, Choc, Matias switches.
+
+* Keyboard Maintainer: Keys of Kings
+* Keyboard Designer: King Icewind
+* Hardware Supported: Twokey PCB, Pro Micro
+* Hardware Availability: www.keysofkings.com
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keysofkings/twokey:default
+
+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).