From b708fca3a289a18ba8b2fae410068fa130c84965 Mon Sep 17 00:00:00 2001 From: haya14busa Date: Mon, 24 Mar 2014 06:57:51 +0900 Subject: [PATCH 1/2] Improve README - Add Installation - Add minimal configuration sample --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 59 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 04510dc..d9c95b2 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,8 @@ EasyMotion is now completely - **Well-behaved**: It's consistent with the default motions of Vim and works well in all modes. And it now supports repeating with the dot operator. -- **Configurable**. You can easily configure its behavior and map it to any key - you want. +- **Configurable**: You can easily configure its behavior and map it to any key +- **Sofisticated**: Provide flawless, smooth and fast motions with minimal keystrokes Even though some default behaviors were modified and many new features were added, I carefully considered backward compatibility. So those of you updating @@ -256,3 +256,60 @@ let g:EasyMotion_smartcase = 1 let g:EasyMotion_use_smartsign_us = 1 ``` + +Installation +------------ +### Pathogen (https://github.com/tpope/vim-pathogen) +``` +git clone https://github.com/Lokaltog/vim-easymotion ~/.vim/bundle/vim-easymotion +``` + +### Vundle (https://github.com/gmarik/vundle) +``` +Bundle 'Lokaltog/vim-easymotion' +``` + +### NeoBundle (https://github.com/Shougo/neobundle.vim) +``` +NeoBundle 'Lokaltog/vim-easymotion' +``` + +Minimal Configuration Tutorial +------------------------------ +**I recommend to configure and map keys by yourself if you are true Vimmer.** + +**Please do not be satisfied with just installing vim-easymotion, configuring it yourself boost your productibity more and more!** + +Default `` prefix isn't easy to press, and I leave them just for backwards compatibility. +You should at least change prefix key like this `map (easymotion-prefix)` + +Minimal but useful vimrc example: + +``` +let g:EasyMotion_do_mapping = 0 " Disable default mappings + +" Bi-directional find motion +" Jump to anywhere you want with minimal keystrokes, with just one key binding. +" `s{char}{label}` +nmap s (easymotion-s) +" or +" `s{char}{char}{label}` +" Need one more keystroke, but on average, it may be more comfortable. +nmap s (easymotion-s2) + +" Turn on case sensitive feature +let g:EasyMotion_smartcase = 1 + +" JK motions: Line motions +map j (easymotion-j) +map k (easymotion-k) +``` +Now, all you need to remember is `s` and JK motions bindings, and it's good enough to boost your cursor speed! + +**`s`** is bidirectional find motion, you can move to anywhere with it. + +**`j`** & **`k`** make it easy to move to the lines. + +Of course you can use any key you want instead of `s` such as ``, `s`, etc... + +If you want to use more useful mappings, please see [:h easymotion.txt](https://github.com/Lokaltog/vim-easymotion/blob/master/doc/easymotion.txt) for more detail. From cc03ee5d7fb85349ec51e6de42677b8b448a1236 Mon Sep 17 00:00:00 2001 From: haya14busa Date: Mon, 24 Mar 2014 07:30:37 +0900 Subject: [PATCH 2/2] Describe authors section as a table --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d9c95b2..4290195 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,10 @@ Vim motion on speed! About the authors ===== -- Kim Silkebækken (https://github.com/Lokaltog) -- haya14busa (https://github.com/haya14busa) (since version 2.0) +| Authors | | +|------------------|-------------------------------| +| Kim Silkebækken | https://github.com/Lokaltog | +| haya14busa | https://github.com/haya14busa | The EasyMotion project, revived! ======