summaryrefslogtreecommitdiffstats
path: root/keyboards/kbdfans/odin/v2/readme.md
diff options
context:
space:
mode:
authorLex Brugman <lexbrugman@users.noreply.github.com>2022-11-20 09:28:35 +0100
committerGitHub <noreply@github.com>2022-11-20 00:28:35 -0800
commit66e4add9725bac525f9ca6e9e44ccbab2ded5412 (patch)
treecfaa99efb9627524a2a6ab30e6c51aa9c9fbbf47 /keyboards/kbdfans/odin/v2/readme.md
parent7357426bc3fbbd47893599af2a6623b66d07c9bb (diff)
[Keyboard] Add support for KBDfans Odin V2 (#18910)
Diffstat (limited to 'keyboards/kbdfans/odin/v2/readme.md')
-rw-r--r--keyboards/kbdfans/odin/v2/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/kbdfans/odin/v2/readme.md b/keyboards/kbdfans/odin/v2/readme.md
new file mode 100644
index 0000000000..52ac9ad699
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/readme.md
@@ -0,0 +1,21 @@
+# ODIN V2
+
+A customizable HOTSWAP keyboard.
+
+* Keyboard Maintainer: [lexbrugman](https://github.com/lexbrugman)
+* Hardware Supported: KBDFANS
+* Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kbdfans/odin/v2: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 `QK_BOOT` 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).