summaryrefslogtreecommitdiff
path: root/keyboards/blu/vimclutch/readme.md
diff options
context:
space:
mode:
authorAgent Blu, 006 <blu006@ucr.edu>2023-03-20 20:13:27 -0700
committerGitHub <noreply@github.com>2023-03-20 20:13:27 -0700
commit8bb7d24fba6c70dd5865b4d92421fcb9248b7f0b (patch)
tree7c6024eb58aa67e14ec266e00641b0503939f141 /keyboards/blu/vimclutch/readme.md
parent50b12ece13203e85eabc643159517c7eb4e20dc3 (diff)
[Keyboard] Add Blu vimclutch (#20060)
Co-authored-by: jack <0x6a73@protonmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/blu/vimclutch/readme.md')
-rw-r--r--keyboards/blu/vimclutch/readme.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/keyboards/blu/vimclutch/readme.md b/keyboards/blu/vimclutch/readme.md
new file mode 100644
index 0000000000..bbc6b98260
--- /dev/null
+++ b/keyboards/blu/vimclutch/readme.md
@@ -0,0 +1,36 @@
+# blu vimclutch
+
+[blu006](https://github.com/blu006)'s vimclutch implementation using QMK
+
+* Keyboard Maintainer: [blu006](https://github.com/blu006)
+* Hardware Supported: [github link](https://github.com/blu006/vimclutch_hw)
+* Hardware Vendors Listed on the Page
+
+This keyboard is designed to be placed from left-to-right with the USB-B micro port aligned to the left side and the widest side horizontally aligned. Some may call this the "transverse" orientation. The two tactile buttons are for layer switching and are numbered from left-to-right. The default state is for the leftmost layer to be active. With the default layout, this is the "voice chat" mode which uses `F13` as a push-to-talk button.
+
+On the default keymap, here's what happens with your clutch:
+* On press, `ESC` and then `a` are pressed.
+* On release, `ESC` is pressed
+
+You can also use the shift key on your keyboard to jump to the end of line.
+
+Here are some included keymaps and their modes to get you started:
+* default: voice chat and vim clutch
+* vc_i: the same as default but using `i` instead of `a`
+* vim_ai: vim clutch only, selectable between `a` and `i`
+
+Also includes a mode for single-keypress in case of "push to talk clutch"
+
+Make example for this keyboard after setting up your development environment:
+
+ make blu/vimclutch:default
+
+Flashing example for this keyboard:
+
+ make blu/vimclutch:default
+
+## Bootloader
+
+Reset button on the reverse side of the enclosure for initializing flashing.
+
+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).