summaryrefslogtreecommitdiff
path: root/keyboards/dcpedit/redherring/readme.md
diff options
context:
space:
mode:
authorMing-Gih Lam <dcpedit@hotmail.com>2023-11-07 18:18:09 -0800
committerGitHub <noreply@github.com>2023-11-07 18:18:09 -0800
commit7324650714d53142ec643bb019f6afa7e9cd9dbd (patch)
treeed43f3878785c999f5dc39b632c5548c1f3f836e /keyboards/dcpedit/redherring/readme.md
parent5b25a8aa32e79b12644be05359d2f6c1d599e40d (diff)
Red Herring PCB support (#22409)
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com> Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/dcpedit/redherring/readme.md')
-rw-r--r--keyboards/dcpedit/redherring/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/dcpedit/redherring/readme.md b/keyboards/dcpedit/redherring/readme.md
new file mode 100644
index 0000000000..67f2bdf33d
--- /dev/null
+++ b/keyboards/dcpedit/redherring/readme.md
@@ -0,0 +1,27 @@
+# Red Herring
+
+![Red Herring](https://i.imgur.com/b6lKmW0h.jpg)
+
+Unibody ergonomic orthilinar keyboard with through-hole components. Supports standard keycaps, a 64x128 OLED, large rotary encoder knob, and a solenoid.
+
+* Keyboard Maintainer: [dcpedit](https://github.com/dcpedit)
+* Hardware Supported: ATMEGA32A
+* Hardware Availability: https://github.com/dcpedit/redherring
+
+Make example for this keyboard (after setting up your build environment):
+
+ make dcpedit/redherring:default
+
+Flashing example for this keyboard:
+
+ make dcpedit/redherring: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 ESC key (top-left key) and plug in the keyboard
+* **Physical reset button**: On the PCB, while holding down the BOOT button, press and release the RESET button
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available \ No newline at end of file