diff options
Diffstat (limited to 'keyboards/kbdfans/odinmini/readme.md')
| -rw-r--r-- | keyboards/kbdfans/odinmini/readme.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/kbdfans/odinmini/readme.md b/keyboards/kbdfans/odinmini/readme.md new file mode 100644 index 0000000000..6a0c87c9e6 --- /dev/null +++ b/keyboards/kbdfans/odinmini/readme.md @@ -0,0 +1,21 @@ +# ODIN MINI + +A customizable Hotswap 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/odinmini:default + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix +* **Physical reset button**: Double tap the reset button on the back of the PCB +* **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). |