aboutsummaryrefslogtreecommitdiff
path: root/keyboards/cannonkeys/vida/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@gmail.com>2025-04-08 18:13:16 -0400
committerGitHub <noreply@github.com>2025-04-09 08:13:16 +1000
commit0ec96ddd52cd6f4851beb5f387f3bd67b306f8b8 (patch)
treebfa62e18f89694d2eec5077307e1edb9a3c9c43c /keyboards/cannonkeys/vida/readme.md
parent2645751ce1aed528056c9bd6acef8a279b3c4a61 (diff)
Add Vida to QMK (#24225)
Co-authored-by: jack <jack@pngu.org> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Diffstat (limited to 'keyboards/cannonkeys/vida/readme.md')
-rw-r--r--keyboards/cannonkeys/vida/readme.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/vida/readme.md b/keyboards/cannonkeys/vida/readme.md
new file mode 100644
index 0000000000..2143a7d20a
--- /dev/null
+++ b/keyboards/cannonkeys/vida/readme.md
@@ -0,0 +1,31 @@
+# Vida Keyboard PCB
+
+Vida PCB from CannonKeys
+
+This folder has files for both the wired hotswap and solderable versions of the Vida PCB
+
+The hotswap version does not have as much layout support as the solderable version (no ISO, no split space)
+The hotswap version does not support per key LED backlighting
+
+* 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/vida:hotswap:default
+
+Flashing example for this keyboard:
+
+ make cannonkeys/vida:hotswap: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**: 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