Просмотр исходного кода

Make it clear that &runtimepath is updated on plug#end()

Close #260
Junegunn Choi 10 лет назад
Родитель
Сommit
2653f4bdfd
2 измененных файлов с 12 добавлено и 2 удалено
  1. 11 2
      README.md
  2. 1 0
      plug.vim

+ 11 - 2
README.md

@@ -22,7 +22,7 @@ A minimalist Vim plugin manager.
 [nv]: http://neovim.org/
 [startup-time]: http://junegunn.kr/images/vim-startup-time.png
 
-### Usage
+### Installation
 
 [Download plug.vim](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim)
 and put it in ~/.vim/autoload
@@ -32,7 +32,15 @@ curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
     https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
 ```
 
-Edit your .vimrc
+### Usage
+
+Add a vim-plug section to your .vimrc:
+
+1. Begin the section with `plug#begin()`
+1. List the plugins with `Plug` commands
+1. `plug#end()` to add the plugins to `&runtimepath`
+
+#### Example
 
 ```vim
 call plug#begin('~/.vim/plugged')
@@ -60,6 +68,7 @@ Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': 'yes \| ./install' }
 " Unmanaged plugin (manually installed and updated)
 Plug '~/my-prototype-plugin'
 
+" Add plugins to &runtimepath
 call plug#end()
 ```
 

+ 1 - 0
plug.vim

@@ -33,6 +33,7 @@
 "   " Unmanaged plugin (manually installed and updated)
 "   Plug '~/my-prototype-plugin'
 "
+"   " Add plugins to &runtimepath
 "   call plug#end()
 "
 " Then reload .vimrc and :PlugInstall to install plugins.