make this repo compatible with plugin managers
This commit is contained in:
27
README.md
27
README.md
@@ -2,19 +2,22 @@
|
||||
|
||||
## Usage
|
||||
|
||||
If you find yourself wanting to use these settings, do the following:
|
||||
If you find yourself wanting to use these settings, `git clone` this repository,
|
||||
and copy or link the following directories:
|
||||
|
||||
```
|
||||
./colors -> ~/.vim/colors
|
||||
./ftplugin -> ~/.vim/ftplugin
|
||||
./.vimrc -> ~/.vimrc
|
||||
colors -> ~/.vim/colors
|
||||
ftplugin -> ~/.vim/ftplugin
|
||||
plugin -> ~/.vim/plugin
|
||||
```
|
||||
|
||||
Also create two files `~/.vimplugin` and `~/.vimlocal`. The first one contains
|
||||
commands for your plugin manager. The idea is that you might need a different
|
||||
set of plugins on different machines. Some plugins require paths to programs,
|
||||
which can differ from machine to machine too.
|
||||
In `.vimlocal` you should should put settings that are local to the machine.
|
||||
You might use `plugin_template.vim` and `locals_template.vim` for reference.
|
||||
Alternatively, if you are on UNIX and haven't configured VIM yet, you could just
|
||||
run `setup.sh`, which will do everything for you.
|
||||
In `plugin/settings.vim` are settings that you can use on every workstation.
|
||||
You can put into `~/.vimrc` settings that are local to the machine (such as
|
||||
plugins, settings for plugins, font settings, etc.). Some reasonable default
|
||||
local settings can be found in `.vimrc_template`.
|
||||
|
||||
If you are on UNIX and haven't configured VIM yet, you could just
|
||||
run `setup.sh`, which will create links from the repository to the `~/.vim`
|
||||
folder and install plugin manager Vundle. Because of links, you shouldn't move
|
||||
or remove the directory in which you cloned this repo. The benefit is that you
|
||||
can get updates to the settings with just `git pull`.
|
||||
|
||||
Reference in New Issue
Block a user