summaryrefslogtreecommitdiff
path: root/keyboards/bredworks/wyvern_hs/readme.md
diff options
context:
space:
mode:
authorDeskDaily <65656486+DeskDaily@users.noreply.github.com>2023-09-25 10:28:48 +0800
committerGitHub <noreply@github.com>2023-09-25 12:28:48 +1000
commit9d3c0018c118ed2cf5fc251e24774a8c52df09ee (patch)
tree119d665f24501dda630ff610dee7465951ff8d6e /keyboards/bredworks/wyvern_hs/readme.md
parent133be8759a2a01bd0e917543e6b1f3d84830d9a9 (diff)
Added Wyvern Hotswap by BredWorks (#21141)
Co-authored-by: Neil Brian Ramirez <nightlykeyboards@gmail.com> Co-authored-by: Neil Brian Ramirez <nightlyboards@gmail.com>
Diffstat (limited to 'keyboards/bredworks/wyvern_hs/readme.md')
-rw-r--r--keyboards/bredworks/wyvern_hs/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/bredworks/wyvern_hs/readme.md b/keyboards/bredworks/wyvern_hs/readme.md
new file mode 100644
index 0000000000..0d0ed4e099
--- /dev/null
+++ b/keyboards/bredworks/wyvern_hs/readme.md
@@ -0,0 +1,23 @@
+# Bredworks Wyvern HS
+
+* Keyboard Maintainer: [DeskDaily](https://github.com/DeskDaily)
+* Hardware Supported: Atmega32u4
+* Hardware Availability: [BredWorks](https://bredworks.com/products/wyvern-hotswap-pcb)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make bredworks/wyvern_hs:default
+
+Flashing example for this keyboard:
+
+ make bredworks/wyvern_hs:default:flash
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the upper left key/esc) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **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).