aboutsummaryrefslogtreecommitdiff
path: root/keyboards/cannonkeys/link/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@gmail.com>2025-04-14 12:52:51 -0400
committerGitHub <noreply@github.com>2025-04-14 09:52:51 -0700
commitaf141d1a5cd4a740e07f8195d9f1ec18e74bfdb7 (patch)
treeecef936048f8a8ef96d4ee5331176c45755a8707 /keyboards/cannonkeys/link/readme.md
parent1388daa0cc2f9e3e171de8ed5388ee94c8a9103a (diff)
Add Link keyboard (#25058)
Co-authored-by: jack <jack@pngu.org> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/cannonkeys/link/readme.md')
-rw-r--r--keyboards/cannonkeys/link/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/link/readme.md b/keyboards/cannonkeys/link/readme.md
new file mode 100644
index 0000000000..461be86180
--- /dev/null
+++ b/keyboards/cannonkeys/link/readme.md
@@ -0,0 +1,27 @@
+# Link
+
+The Link is a Sofle58 inspired Ergo Split keyboard from CannonKeys.
+It uses 1.3" SH1107 screens and ALPS EC11 compatible encoders.
+
+* 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/link:default
+
+Flashing example for this keyboard:
+
+ make cannonkeys/link: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-most and outer-most key in the matrix 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