summaryrefslogtreecommitdiff
path: root/keyboards/cutie_club/fidelity/readme.md
diff options
context:
space:
mode:
authorCallum Hart <mini-ninja-64@users.noreply.github.com>2023-07-03 21:35:37 +0100
committerGitHub <noreply@github.com>2023-07-03 13:35:37 -0700
commit989f387d1838fc720a6f12f2ffde3acc0e4b1920 (patch)
tree582e26aa5730ebf1531bf36ae12d292095922105 /keyboards/cutie_club/fidelity/readme.md
parent4e27bd2a9aa929c14d9562c949029af3c9b55c23 (diff)
[Keyboard] Add Fidelity keyboard (#20922)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/cutie_club/fidelity/readme.md')
-rw-r--r--keyboards/cutie_club/fidelity/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/cutie_club/fidelity/readme.md b/keyboards/cutie_club/fidelity/readme.md
new file mode 100644
index 0000000000..9cec49d2cf
--- /dev/null
+++ b/keyboards/cutie_club/fidelity/readme.md
@@ -0,0 +1,26 @@
+# Fidelity
+
+![Fidelity](https://i.imgur.com/6xelfJeh.jpeg)
+
+The Fidelity is a custom 65% keyboard, a collaboration between HAND Engineering and Koen.
+
+* Keyboard Maintainer: [Cutie Club](https://github.com/cutie-club/)
+* Hardware Supported: STM32F072 based PCB for the Fidelity keyboard
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cutie_club/fidelity:default
+
+Flashing example for this keyboard:
+
+ make cutie_club/fidelity: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 (the top left key) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the front of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available