summaryrefslogtreecommitdiff
path: root/keyboards/cannonkeys/cloudline/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@klaviyo.com>2022-06-07 14:29:31 -0400
committerGitHub <noreply@github.com>2022-06-07 11:29:31 -0700
commitfbe236fa77276acdf69f79f53f4c2c50c0449fc5 (patch)
tree08bdc5def48f723cad39b7035638c00d90552be5 /keyboards/cannonkeys/cloudline/readme.md
parentb8bbd0cb9a6f5ded5c1ec31bf0249ed843d200e8 (diff)
[Keyboard] Add Cloudline PCB support (#17253)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/cannonkeys/cloudline/readme.md')
-rw-r--r--keyboards/cannonkeys/cloudline/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/cloudline/readme.md b/keyboards/cannonkeys/cloudline/readme.md
new file mode 100644
index 0000000000..ddd15a05a5
--- /dev/null
+++ b/keyboards/cannonkeys/cloudline/readme.md
@@ -0,0 +1,20 @@
+# CannonKeys Cloudline
+
+Cloudline Keyboard by Justin
+
+* Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan)
+* Hardware Supported: STM32F072CBT6
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cannonkeys/cloudline:default
+
+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 "0" and briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available