More docs
This commit is contained in:
parent
098b31cd9b
commit
8289e899b5
14
README.md
14
README.md
@ -1,6 +1,6 @@
|
|||||||
## About
|
## About
|
||||||
|
|
||||||
[Vundle] is a short cut for **V**imb**undle** and is a small plugin for managing [Vim] plugins.
|
[Vundle] is a short cut for **V**imb**undle** and is a [Vim] plugin manager.
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
[Vundle] allows to:
|
[Vundle] allows to:
|
||||||
@ -26,7 +26,7 @@ in order to install/search [all available vim scripts]
|
|||||||
|
|
||||||
2. Configure bundles:
|
2. Configure bundles:
|
||||||
|
|
||||||
Append to your <code>~/.vimrc</code>:
|
Append to your `~/.vimrc`:
|
||||||
|
|
||||||
set rtp+=~/.vim/vundle.git/
|
set rtp+=~/.vim/vundle.git/
|
||||||
call vundle#rc()
|
call vundle#rc()
|
||||||
@ -41,9 +41,9 @@ in order to install/search [all available vim scripts]
|
|||||||
|
|
||||||
3. Install configured bundles:
|
3. Install configured bundles:
|
||||||
|
|
||||||
Launch <code>vim</code>, run <code>:BundleInstall</code> (**no `Vim` restart required** since v0.5)
|
Launch `vim`, run `:BundleInstall` (**no `Vim` restart required** since v0.5)
|
||||||
|
|
||||||
Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to <code>~/.vim/bundle/</code>.
|
Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to `~/.vim/bundle/`.
|
||||||
|
|
||||||
## Script installation
|
## Script installation
|
||||||
|
|
||||||
@ -60,7 +60,7 @@ lists search results in new split window, ie:
|
|||||||
Bundle "VimFootnotes"
|
Bundle "VimFootnotes"
|
||||||
Bundle "foo.vim"
|
Bundle "foo.vim"
|
||||||
|
|
||||||
so you can just copy ones you need to <code>.vimrc</code>.
|
so you can just copy ones you need to `.vimrc`.
|
||||||
|
|
||||||
:BundleSearch! foo
|
:BundleSearch! foo
|
||||||
|
|
||||||
@ -86,7 +86,7 @@ confirms removal of unused script dirs from your `.vim/bundle`. `BundleClean!` d
|
|||||||
|
|
||||||
## Also
|
## Also
|
||||||
|
|
||||||
* Vundle wasn't tested on windows(so if you care i'm waiting for you pull request)
|
* Vundle wasn't tested on windows(so if you care i'm waiting for your pull request)
|
||||||
* Vundle tries to be as [KISS](http://en.wikipedia.org/wiki/KISS_principle) as possible
|
* Vundle tries to be as [KISS](http://en.wikipedia.org/wiki/KISS_principle) as possible
|
||||||
|
|
||||||
## TODO:
|
## TODO:
|
||||||
@ -94,12 +94,12 @@ confirms removal of unused script dirs from your `.vim/bundle`. `BundleClean!` d
|
|||||||
|
|
||||||
* √ activate newly added bundles on .vimrc reload or after :BundleInstall
|
* √ activate newly added bundles on .vimrc reload or after :BundleInstall
|
||||||
* √ use preview window for search results
|
* √ use preview window for search results
|
||||||
|
* Vim documentation
|
||||||
* improve error handling
|
* improve error handling
|
||||||
* allow specify revision/version?
|
* allow specify revision/version?
|
||||||
* search by description aswell
|
* search by description aswell
|
||||||
* show descrption in search results
|
* show descrption in search results
|
||||||
* instead sourcing .vimrc before installation come up with another solution
|
* instead sourcing .vimrc before installation come up with another solution
|
||||||
* documentation
|
|
||||||
* tests
|
* tests
|
||||||
* make it rock!
|
* make it rock!
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user