From 71209dcdee1f163dabfe113f9a97e11fa0bbdb56 Mon Sep 17 00:00:00 2001 From: Junegunn Choi Date: Mon, 8 Apr 2013 00:02:41 +0900 Subject: [PATCH] README --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index eb694d2..ceb7fad 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,22 @@ vim-lesser-align ================ Yet another Vim alignment plugin without too much ambition. + This plugin clearly has less features than the other pre-existing ones with the similar goals, -but is simpler, easier to use, and good enough for most of the cases. +but it is simpler, easier to use, and good enough for most of the cases. Usage ----- Vim-lesser-align defines `LesserAlign` command in the visual mode. + For convenience, it is advised that you define a mapping for triggering it in your `.vimrc`. ```vim vnoremap :LesserAlign ``` -Then, a key sequence becomes a combination of 3 parts. +Then a key sequence becomes a combination of 3 parts. 1. `` - Shortcut for `:LesserAssign` @@ -25,23 +27,24 @@ Then, a key sequence becomes a combination of 3 parts. - `...` - `*`: Alignment around all delimiters (tabularize) 1. Delimiter - - `=` - - Operators containing equals sign (=, ==, !=, +=, &&=, ...) + - `=`: Operators containing equals sign (=, ==, !=, +=, &&=, ...) - `` - - Space - `:` - `,` - `|` +Examples +-------- + | Keystroke | Description | | ------------------- | ----------------------------------------------------- | -| `=` | *A*lignment around 1st equals sign (and the likes) | -| `2=` | *A*lignment around *2*nd equals sign (and the likes) | -| `3=` | *A*lignment around *3*rd equals sign (and the likes) | -| `*=` | *A*lignment around *all* equals signs (and the likes) | -| `` | *A*lignment around *1*st whitespace | -| `2` | *A*lignment around *2*nd whitespace | -| `:` | *A*lignment around *1*st colon | +| `=` | Alignment around 1st equals sign (and the likes) | +| `2=` | Alignment around 2nd equals sign (and the likes) | +| `3=` | Alignment around 3rd equals sign (and the likes) | +| `*=` | Alignment around all equals signs (and the likes) | +| `` | Alignment around 1st whitespace | +| `2` | Alignment around 2nd whitespace | +| `:` | Alignment around 1st colon | | ... | ... | Author