summaryrefslogtreecommitdiff
path: root/keyboards/relapsekb/or87/readme.md
diff options
context:
space:
mode:
authorRamon Imbao <ramonimbao@gmail.com>2023-12-06 11:34:36 +0800
committerGitHub <noreply@github.com>2023-12-05 20:34:36 -0700
commit6c2c211d8a12ecae47881a898c89275113ee92fc (patch)
tree1f84e93696a2c395ca2a80e9f2cd5bf6754a4522 /keyboards/relapsekb/or87/readme.md
parentaa8e2065f17de51d99769e15d2879719b9475ef2 (diff)
[Keyboard] Add Relapse-KB OR87 (#22458)
* Add relapsekb h87nu * Change name * Add missing license headers * Apply suggestions from code review Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Remove config.h * Update keyboards/relapsekb/or87/readme.md Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> --------- Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Diffstat (limited to 'keyboards/relapsekb/or87/readme.md')
-rw-r--r--keyboards/relapsekb/or87/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/relapsekb/or87/readme.md b/keyboards/relapsekb/or87/readme.md
new file mode 100644
index 0000000000..43b2473015
--- /dev/null
+++ b/keyboards/relapsekb/or87/readme.md
@@ -0,0 +1,26 @@
+# OR87
+
+![OR87](https://i.imgur.com/nvXwreYh.jpg)
+
+TKL keyboard by Relapse-KB.
+
+* Keyboard Maintainer: [Ramon Imbao](https://github.com/ramonimbao)
+* Hardware Supported: ATmega32u4
+
+Make example for this keyboard (after setting up your build environment):
+
+ make relapsekb/or87:default
+
+Flashing example for this keyboard:
+
+ make relapsekb/or87: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 - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available