summaryrefslogtreecommitdiff
path: root/keyboards/3keyecosystem/2key2/readme.md
diff options
context:
space:
mode:
authorJohn Mueller <softplus@users.noreply.github.com>2021-09-11 16:33:48 +0200
committerGitHub <noreply@github.com>2021-09-11 07:33:48 -0700
commit22dd68520b4f55ed7c953a67cfb904f85cc88982 (patch)
treeb52a2183b3bfd2245eaf9cafa37a0d0f4e4cc976 /keyboards/3keyecosystem/2key2/readme.md
parent99d465bee0d97d201e5883bde14f0ff0e4cf6e6b (diff)
[Keyboard] Add 3keyecosystem and 2key2 keyboard (#14023)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/3keyecosystem/2key2/readme.md')
-rw-r--r--keyboards/3keyecosystem/2key2/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/3keyecosystem/2key2/readme.md b/keyboards/3keyecosystem/2key2/readme.md
new file mode 100644
index 0000000000..3befa292ff
--- /dev/null
+++ b/keyboards/3keyecosystem/2key2/readme.md
@@ -0,0 +1,24 @@
+# 3-Key-Ecosystem - 2key2
+
+![keyboard](https://i.imgur.com/IJ1Zyc7.jpeg)
+
+This is a 2x1 macro keyboard with WS2812B key lighting.
+It's designed for a modular keyboard mount using an ATmega32U4.
+
+* Keyboard Maintainer: [softplus](https://github.com/softplus)
+* Hardware Supported: [3keyecosystem-2key2](https://github.com/softplus/3keyecosystem/tree/main/2key2)
+* Hardware Availability: Open-Source files at above link
+
+Make example for this keyboard (after setting up your build environment):
+
+ make 3keyecosystem/2key2:default
+
+Flashing example for this keyboard:
+
+ make 3keyecosystem/2key2:default:flash
+
+## Bootloader
+
+To Enter the bootloader, click reset button on the main board.
+
+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).