summaryrefslogtreecommitdiff
path: root/keyboards/projectcain/vault45/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/projectcain/vault45/readme.md')
-rw-r--r--keyboards/projectcain/vault45/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/projectcain/vault45/readme.md b/keyboards/projectcain/vault45/readme.md
new file mode 100644
index 0000000000..a84feaf224
--- /dev/null
+++ b/keyboards/projectcain/vault45/readme.md
@@ -0,0 +1,21 @@
+# vault45
+
+![vault45](https://i.imgur.com/SYrsbQEh.jpeg)
+
+This is a 40% HHKB-style keyboard inspired by the JD45 with updated bottom row options and rotary encoders.
+
+* Keyboard Maintainer: [projectcain](https://github.com/projectcain)
+* Hardware Supported: Vault 45 PCB
+* Hardware Availability: mechvault.net
+
+To reset the keyboard into bootloader mode, short the two pads labeled "Reset" on the left side of the pcb
+
+Make example for this keyboard (after setting up your build environment):
+
+ make projectcain/vault45:default
+
+Flashing example for this keyboard:
+
+ make projectcain/vault45: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).