summaryrefslogtreecommitdiff
path: root/keyboards/cannonkeys/vector/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@gmail.com>2022-09-14 14:13:13 -0400
committerGitHub <noreply@github.com>2022-09-14 11:13:13 -0700
commit017398c283fe5a189d7d029f60587342be47b002 (patch)
tree97be38208cf17b38c685607c55e7fe921d690148 /keyboards/cannonkeys/vector/readme.md
parent624ab64750ed05e6da46ce3c261e97c7e39c6206 (diff)
[Keyboard] Add Vector PCB (#17380)
Diffstat (limited to 'keyboards/cannonkeys/vector/readme.md')
-rw-r--r--keyboards/cannonkeys/vector/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/vector/readme.md b/keyboards/cannonkeys/vector/readme.md
new file mode 100644
index 0000000000..1abbb25819
--- /dev/null
+++ b/keyboards/cannonkeys/vector/readme.md
@@ -0,0 +1,25 @@
+# Vector
+
+*A PCB mount 60% designed by ai03*
+
+* Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan)
+* Hardware Supported: STM32F072CBT6
+* Hardware Availability: [CannonKeys](https://cannonkeys.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cannonkeys/vector:default
+
+Flashing example for this keyboard:
+
+ make cannonkeys/vector: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**: Swap the boot switch on the back of the PCB to "1" and hit the reset button
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available