vim-plug/README.md

72 lines
1.5 KiB
Markdown
Raw Normal View History

2013-09-10 07:58:41 -07:00
vim-plug
========
2013-09-10 20:06:57 -07:00
A single-file Vim plugin manager.
2013-09-10 07:58:41 -07:00
2013-09-10 08:08:51 -07:00
### Pros.
2013-09-10 07:58:41 -07:00
2013-09-10 20:06:57 -07:00
- Easier to setup
2013-09-10 07:58:41 -07:00
- Parallel installation/update (requires +ruby)
- Alternative directory structure: user/repo
- Make it easier to switch plugins of the same name from different authors
2013-09-10 07:58:41 -07:00
2013-09-10 08:08:51 -07:00
### Cons.
2013-09-10 07:58:41 -07:00
- Everything else
2013-09-10 07:58:41 -07:00
2013-09-10 08:08:51 -07:00
### Usage
2013-09-10 07:58:41 -07:00
Download plug.vim and put it in ~/.vim/autoload
```sh
mkdir -p ~/.vim/autoload
2013-09-10 20:06:57 -07:00
curl -fLo ~/.vim/autoload/plug.vim https://raw.github.com/junegunn/vim-plug/master/plug.vim
2013-09-10 07:58:41 -07:00
```
Edit your .vimrc
```vim
2013-09-16 01:37:09 -07:00
call plug#begin()
2013-09-10 07:58:41 -07:00
Plug 'junegunn/seoul256'
Plug 'junegunn/vim-easy-align'
" Plug 'user/repo', 'branch_or_tag'
" ...
2013-09-16 01:37:09 -07:00
call plug#end()
2013-09-10 07:58:41 -07:00
```
2013-09-10 08:08:51 -07:00
Then :PlugInstall to install plugins. (Default plugin directory: `~/.vim/plugged`)
2013-09-10 07:58:41 -07:00
2013-09-10 08:08:51 -07:00
You can change the location of the plugins with `plug#init(path)` call.
2013-09-10 07:58:41 -07:00
2013-09-10 08:08:51 -07:00
### Commands
2013-09-10 07:58:41 -07:00
2013-09-10 08:08:51 -07:00
| Command | Description |
| ---------------------- | ------------------------- |
| PlugInstall [#threads] | Install plugins |
| PlugUpdate [#threads] | Install or update plugins |
| PlugClean | Remove unused directories |
| PlugUpgrade | Upgrade vim-plug itself |
2013-09-10 20:06:57 -07:00
(Default number of threads = `g:plug_threads` or 16)
2013-09-10 07:58:41 -07:00
2013-09-16 09:59:18 -07:00
### Screenshots
#### Parallel installation
![](https://raw.github.com/junegunn/vim-plug/master/gif/pi.gif)
#### Serial installation
![](https://raw.github.com/junegunn/vim-plug/master/gif/si.gif)
#### Parallel update
![](https://raw.github.com/junegunn/vim-plug/master/gif/pu.gif)
#### Serial update
![](https://raw.github.com/junegunn/vim-plug/master/gif/su.gif)