Skip to content

Commit

Permalink
added a readme based on the vimdoc introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
cowens committed Jun 19, 2011
1 parent c0a4929 commit 5c2d405
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README
@@ -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

0 comments on commit 5c2d405

Please sign in to comment.