summaryrefslogtreecommitdiff
path: root/keyboards/doio/kb3x/readme.md
diff options
context:
space:
mode:
authorDOIO2022 <116554792+DOIO2022@users.noreply.github.com>2024-03-29 12:53:11 +0800
committerGitHub <noreply@github.com>2024-03-28 21:53:11 -0700
commiteac380926655d59db7471a9085a96b10b7671ce2 (patch)
tree3ae78be70069f27b997ea8c7651a6ea8f2d9ea38 /keyboards/doio/kb3x/readme.md
parentafafce0a5e858efbc693df4636685eccab2f4968 (diff)
[Keyboard] Add kb3x keyboard (#23268)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>
Diffstat (limited to 'keyboards/doio/kb3x/readme.md')
-rw-r--r--keyboards/doio/kb3x/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/doio/kb3x/readme.md b/keyboards/doio/kb3x/readme.md
new file mode 100644
index 0000000000..c27c983d49
--- /dev/null
+++ b/keyboards/doio/kb3x/readme.md
@@ -0,0 +1,26 @@
+# doio/kb3x
+
+![kb3x-01](https://i.imgur.com/6DvIu9Mh.png)
+
+QMK for DOIO Knob keypad .
+
+* Keyboard Maintainer: DOIO2022
+* Hardware Supported: DOIO Knob keypad
+
+Make example for this keyboard (after setting up your build environment):
+
+ make doio/kb3x:default
+
+Flashing example for this keyboard:
+
+ make doio/kb3x: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available