summaryrefslogtreecommitdiff
path: root/keyboards/kbdfans/odin/rgb/readme.md
diff options
context:
space:
mode:
authormoyi4681 <moyi4681@users.noreply.github.com>2021-11-29 16:28:00 +0800
committerGitHub <noreply@github.com>2021-11-29 00:28:00 -0800
commit9cc97302abcc41106bb1a6fc6eb626c1736b8ce7 (patch)
treeb879acf52a9dd30ee645cd65f5ea72628bcbb782 /keyboards/kbdfans/odin/rgb/readme.md
parent4c0ecd4910af46f9e7b5ca01ea2e016d69092faa (diff)
[Keyboard] add odin keyboard (#15150)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/kbdfans/odin/rgb/readme.md')
-rw-r--r--keyboards/kbdfans/odin/rgb/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/kbdfans/odin/rgb/readme.md b/keyboards/kbdfans/odin/rgb/readme.md
new file mode 100644
index 0000000000..3530fcca40
--- /dev/null
+++ b/keyboards/kbdfans/odin/rgb/readme.md
@@ -0,0 +1,21 @@
+# ODIN RGB
+
+A customizable HOTSWAP RGB keyboard.
+
+* Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)
+* Hardware Supported: KBDFANS
+* Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kbdfans/odin/rgb:default
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix
+* **Physical reset button**:press and hold the button on the back of the PCB, then plugin to PC
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+
+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).