qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (1848B)


      1 # blu vimclutch
      2 
      3 [blu006](https://github.com/blu006)'s vimclutch implementation using QMK
      4 
      5 * Keyboard Maintainer: [blu006](https://github.com/blu006)
      6 * Hardware Supported: [github link](https://github.com/blu006/vimclutch_hw)
      7 * Hardware Vendors Listed on the Page
      8 
      9 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.
     10 
     11 On the default keymap, here's what happens with your clutch:
     12 * On press, `ESC` and then `a` are pressed.
     13 * On release, `ESC` is pressed
     14 
     15 You can also use the shift key on your keyboard to jump to the end of line.
     16 
     17 Here are some included keymaps and their modes to get you started:
     18 * default: voice chat and vim clutch
     19 * vc_i: the same as default but using `i` instead of `a`
     20 * vim_ai: vim clutch only, selectable between `a` and `i`
     21 
     22 Make example for this keyboard after setting up your development environment:
     23 
     24     make blu/vimclutch:default
     25       
     26 Flashing example for this keyboard:
     27 
     28     make blu/vimclutch:default
     29 
     30 ## Bootloader
     31 
     32 Reset button on the reverse side of the enclosure for initializing flashing.
     33 
     34 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).
     35 
     36 ## Hardware Revision Compatibility
     37 This keyboard as-it-is in the QMK repository at the is only designed to work with Revision B (and possibly beyond!)
     38