summaryrefslogtreecommitdiffstats
path: root/keyboards/cannonkeys/ripple/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@gmail.com>2023-04-03 18:56:12 -0400
committerGitHub <noreply@github.com>2023-04-04 08:56:12 +1000
commita434507ab4dcdf437678587e92bab18323d7d3c5 (patch)
treec6e71c7a4db4ccf9f85d3bf2c3833e1e8a66185b /keyboards/cannonkeys/ripple/readme.md
parentee8c86702ea09bfbf4bf8daf015d79362293bb41 (diff)
Add Ripple TKL Keyboard firmware (#20301)
Diffstat (limited to 'keyboards/cannonkeys/ripple/readme.md')
-rw-r--r--keyboards/cannonkeys/ripple/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/ripple/readme.md b/keyboards/cannonkeys/ripple/readme.md
new file mode 100644
index 0000000000..23a31b4a43
--- /dev/null
+++ b/keyboards/cannonkeys/ripple/readme.md
@@ -0,0 +1,24 @@
+# CannonKeys Ripple
+
+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:default
+
+Flashing example for this keyboard:
+
+ make cannonkeys/ripple: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**: 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