summaryrefslogtreecommitdiff
path: root/keyboards/cannonkeys/ripple_hs/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@gmail.com>2023-04-03 18:55:38 -0400
committerGitHub <noreply@github.com>2023-04-04 08:55:38 +1000
commitee8c86702ea09bfbf4bf8daf015d79362293bb41 (patch)
tree080de792d6b877b0b8046782d9f15357120ce732 /keyboards/cannonkeys/ripple_hs/readme.md
parent246cf99b4b029b6d36e82a0c4c3aed11abb2ff5e (diff)
Add Ripple TKL Hotswap Firmware (#20302)
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>
Diffstat (limited to 'keyboards/cannonkeys/ripple_hs/readme.md')
-rw-r--r--keyboards/cannonkeys/ripple_hs/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/ripple_hs/readme.md b/keyboards/cannonkeys/ripple_hs/readme.md
new file mode 100644
index 0000000000..f919f46c6f
--- /dev/null
+++ b/keyboards/cannonkeys/ripple_hs/readme.md
@@ -0,0 +1,24 @@
+# CannonKeys Ripple HS
+
+Ripple Keyboard by Upas
+
+* Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan)
+* Hardware Supported: STM32F072CBT6
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cannonkeys/ripple_hs:default
+
+Flashing example for this keyboard:
+
+ make cannonkeys/ripple_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 top left key and plug in the keyboard
+* **Physical reset button**: Toggle the switch on the back of the pcb to "1" and briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available. In the pre-supplied keymaps it is on the second layer, replacing the R key.