keychron_qmk_firmware/users/xtonhasvim/readme.md


# Xton has Vim!

Contains common code for Xton's vim emulation (vimulation?) layer.

Inspired/stolen from the `ergodox_ez/vim` keymap. Rewritten to be a more straightforward state machine and support more macros. Vim layers `_CMD` and `_EDIT` are designed to lay on top of an otherwise fully-functional layout. `_CMD` runs the entire vim state machine while `_EDIT` should lay across your base layer and mask off just the escape key.

Works via OSX text editing shortcuts, mainly MOD+arrow combinations. This has some limitations and only works on OSX. 

The `_CMD` layer will temporarily disable itself while *CMD* or *ALT* are held down so that typical OSX shortcuts can be used without switching out of vim mode.
Xton's first keymap! (#2941) * FORK! * WIP - just how i like it * empty * more movement * mouse keys * more vimminess * append/insert shift * WIP - vim macros * blocked out layer below in cmd mode. also, about to restart my cmd approach. * WIP - new vim layer ripoff of the ergodox one, but rewritten as a state machine. * debugged some, got key repeat working * moooar coverage * moooar coverage * regular vis mode * basically done with basics. * some refactoring - common movement sequences into helper function - added some rgb controls * modkey passthru feature * stdized on cmd-left/right instead of ctrl-a/e sadly. as there's no reliable shift-ctrl-e * indicator lights * moved vim layer into userspace * cleaned up some yanking edge cases * docs and some tweaks to layerescapes * updated/added license strings * updated comments * moved config changes to keymap * spurious changes removed 2018-05-12 21:52:11 +06:00
			`# Xton has Vim!`

			`Contains common code for Xton's vim emulation (vimulation?) layer.`

			Inspired/stolen from the `ergodox_ez/vim` keymap. Rewritten to be a more straightforward state machine and support more macros. Vim layers `_CMD` and `_EDIT` are designed to lay on top of an otherwise fully-functional layout. `_CMD` runs the entire vim state machine while `_EDIT` should lay across your base layer and mask off just the escape key.

			`Works via OSX text editing shortcuts, mainly MOD+arrow combinations. This has some limitations and only works on OSX.`

			The `_CMD` layer will temporarily disable itself while CMD or ALT are held down so that typical OSX shortcuts can be used without switching out of vim mode.