forked from kana/vim-arpeggio
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added a readme based on the vimdoc introduction
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
arpeggio is a Vim plugin to define another type of key-mapping called | ||
arpeggio-key-mapping -- it consists of 2 or more keys ({lhs}) and it will be | ||
expanded to another key sequence ({rhs}) whenever all keys in {lhs} are | ||
simultaneously pressed. For example: | ||
|
||
Arpeggio inoremap jk <Esc> | ||
" OR | ||
call arpeggio#map('i', '', 0, 'jk', '<Esc>') | ||
|
||
With the above definition, you can input <Esc> in Insert mode by pressing "j" | ||
and "k" simultaneously, while you can move the cursor by pressing "j" or "k" | ||
solely. | ||
|
||
The concept of this plugin is derived from Emacs' [key-chord.el][1], but there are the following differences: | ||
|
||
- Number of keys to be simultaneously pressed is unlimited. | ||
- Custom delay for each key is supported. | ||
This is a generalization of [space-chord.el][2]. | ||
|
||
[1] : http://www.emacswiki.org/emacs/key-chord.el | ||
[2] : http://www.emacswiki.org/emacs/space-chord.el |