summaryrefslogtreecommitdiff
path: root/keyboards/rmi_kb/herringbone/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/rmi_kb/herringbone/readme.md')
-rw-r--r--keyboards/rmi_kb/herringbone/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/rmi_kb/herringbone/readme.md b/keyboards/rmi_kb/herringbone/readme.md
new file mode 100644
index 0000000000..b1f745c719
--- /dev/null
+++ b/keyboards/rmi_kb/herringbone/readme.md
@@ -0,0 +1,23 @@
+# Herringbone and Herringbone Pro
+
+Through-hole 75% keyboards. The Pro version has support for rotary knob, OLED display, and split space.
+
+* Keyboard Maintainer: [Ramon Imbao](https://github.com/ramonimbao)
+* Hardware Supported: ATmega32A
+* Hardware Availability: [Herringbone](https://github.com/ramonimbao/Herringbone)
+
+To get to the bootloader,
+
+1. Press and hold the BOOT button
+
+2. Press the RESET button
+
+3. Release the BOOT button
+
+Make example for these keyboards (after setting up your build environment):
+
+ make ramonimbao/herringbone/v1:default
+
+ make ramonimbao/herringbone/pro: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).