summaryrefslogtreecommitdiff
path: root/keyboards/zykrah/fuyu/readme.md
diff options
context:
space:
mode:
authorZykrah <23428162+zykrah@users.noreply.github.com>2022-12-13 20:23:37 +1100
committerGitHub <noreply@github.com>2022-12-13 01:23:37 -0800
commit411ed54b0a4ab2d9e93b22cb22fc988c763cf277 (patch)
tree53bee9424a08dc3d278baeb7afb31604c6d45027 /keyboards/zykrah/fuyu/readme.md
parent70b9cec3f22faa76edc875e2528a313c00c3445f (diff)
[Keyboard] Add Fuyu (#19055)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/zykrah/fuyu/readme.md')
-rw-r--r--keyboards/zykrah/fuyu/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/zykrah/fuyu/readme.md b/keyboards/zykrah/fuyu/readme.md
new file mode 100644
index 0000000000..88a3ea806e
--- /dev/null
+++ b/keyboards/zykrah/fuyu/readme.md
@@ -0,0 +1,27 @@
+# FUYU
+
+![FUYU](https://i.imgur.com/uWB5EqJh.png)
+
+A F12 TKL H87-Compat Type-C PCB for the Geon F1-8K
+
+* Keyboard Maintainer: [Zykrah](https://github.com/zykrah)
+* Hardware Supported: Fuyu rev1 PCB
+* Hardware Availability: [Github Repo](https://github.com/zykrah/fuyu), [GEON Store](https://geon.works/products/fuyu-pcb-for-f1-8k), [CustomKBD](https://customkbd.com/products/fuyu-pcb-for-f1-8k)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make zykrah/fuyu:default
+
+Flashing example for this keyboard:
+
+ make zykrah/fuyu: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