summaryrefslogtreecommitdiffstats
path: root/keyboards/doio/kb38/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/doio/kb38/readme.md')
-rw-r--r--keyboards/doio/kb38/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/doio/kb38/readme.md b/keyboards/doio/kb38/readme.md
new file mode 100644
index 0000000000..fef8a33f8f
--- /dev/null
+++ b/keyboards/doio/kb38/readme.md
@@ -0,0 +1,24 @@
+# doio/kb38
+
+QMK for Megalodon DOIO Triple Knob 38% with OLED Screen.
+
+* Keyboard Maintainer: [Katrina](https://github.com/PepperKats)
+* Hardware Supported: Megalodon DOIO Triple Knob 38%
+* Hardware Availability: https://www.keebmonkey.com/products/megalodon-doio-triple-knob-38-keyboard-with-oled-screen
+
+Make example for this keyboard (after setting up your build environment):
+
+ make doio/kb38:default
+
+Flashing example for this keyboard:
+
+ make doio/kb38: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:
+
+* **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