summaryrefslogtreecommitdiff
path: root/keyboards/cannonkeys/caerdroia/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@gmail.com>2023-03-10 12:57:11 -0500
committerGitHub <noreply@github.com>2023-03-10 10:57:11 -0700
commitdf814dec7af5e602fc3643b7e8a0e86a7509242d (patch)
tree2502712da6a0a4f474cfb1fbd97a5aa076f16ef1 /keyboards/cannonkeys/caerdroia/readme.md
parent950afdceeb75d06de0bc75f4dc520fb2528c6044 (diff)
Caerdroia Keyboard Firmware (#20036)
Diffstat (limited to 'keyboards/cannonkeys/caerdroia/readme.md')
-rw-r--r--keyboards/cannonkeys/caerdroia/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/caerdroia/readme.md b/keyboards/cannonkeys/caerdroia/readme.md
new file mode 100644
index 0000000000..389467b7b9
--- /dev/null
+++ b/keyboards/cannonkeys/caerdroia/readme.md
@@ -0,0 +1,22 @@
+# Caerdroia by AKB
+
+Caerdroia Keyboard by AKB
+
+* Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan)
+* Hardware Supported: RP2040
+* Hardware Availability: [CannonKeys](https://cannonkeys.com)
+
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cannonkeys/caerdroia: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**: Hold the "BOOTMODE" button on the back of the PCB and briefly press the "RESET" button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available