aboutsummaryrefslogtreecommitdiff
path: root/keyboards/zykrah/fuyu_hs/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/zykrah/fuyu_hs/readme.md')
-rw-r--r--keyboards/zykrah/fuyu_hs/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/zykrah/fuyu_hs/readme.md b/keyboards/zykrah/fuyu_hs/readme.md
new file mode 100644
index 0000000000..41c5cded51
--- /dev/null
+++ b/keyboards/zykrah/fuyu_hs/readme.md
@@ -0,0 +1,27 @@
+# FUYU HOTSWAP
+
+![FUYU HS 7U](https://i.imgur.com/8zjDNJT.jpg)
+
+An F12 TKL Hotswappable H87-Compat Type-C PCB for the Geon F1-8K
+
+* Keyboard Maintainer: [Zykrah](https://github.com/zykrah)
+* Hardware Supported: Fuyu HS 7u rev1, Fuyu HS 6.25u rev1
+* Hardware Availability: [Github Repo](https://github.com/zykrah/fuyu), [GEON Store](https://geon.works/products/fuyu-pcb-for-f1-8k), [Cafege](https://cafege.com.au/products/fuyu-8k-pcb)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make zykrah/fuyu_hs:default
+
+Flashing example for this keyboard:
+
+ make zykrah/fuyu_hs: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 short the `RST` and `GND` pads on the SWD header twice, or short the `BOOT` header and plug in keyboard
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available