summaryrefslogtreecommitdiffstats
path: root/keyboards/cannonkeys/typeb/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@klaviyo.com>2023-02-09 15:55:26 -0500
committerGitHub <noreply@github.com>2023-02-09 13:55:26 -0700
commit758766820d943c83e9f3a0b92b2b47d05b03385e (patch)
treefa6bf62439c373765b802d1f5fd98d8cd7069fbb /keyboards/cannonkeys/typeb/readme.md
parente19cbe25f371e89ae1de04e71e5596625b8783f2 (diff)
Add Type-B firmware to QMK (#19764)
Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/cannonkeys/typeb/readme.md')
-rw-r--r--keyboards/cannonkeys/typeb/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/typeb/readme.md b/keyboards/cannonkeys/typeb/readme.md
new file mode 100644
index 0000000000..e0fb872f38
--- /dev/null
+++ b/keyboards/cannonkeys/typeb/readme.md
@@ -0,0 +1,26 @@
+# Type-B
+
+Type-B Keyboard by bababaul
+
+* 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/typeb:default
+
+Flashing example for this keyboard:
+
+ make cannonkeys/typeb: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 "Recovery" 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