Skip to content

Commit edfb2f4

Browse files
committed
Add installation procedure for vim-plug
It also adds a little refactoring asked inside the pull request.
1 parent c580425 commit edfb2f4

1 file changed

Lines changed: 30 additions & 17 deletions

File tree

README.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,48 @@ This is an [EditorConfig][] plugin for Vim. This plugin can be found on both
1010

1111
To install this plugin, you can use one of the following ways:
1212

13-
- Download the [archive][] and extract it into your Vim runtime directory
14-
(`~/.vim` on UNIX/Linux and `$VIM_INSTALLATION_FOLDER\vimfiles` on windows).
15-
You should have 3 sub-directories in this runtime directory now: "autoload",
16-
"doc" and "plugin".
13+
### Install with the archive
1714

18-
OR
15+
Download the [archive][] and extract it into your Vim runtime directory
16+
(`~/.vim` on UNIX/Linux and `$VIM_INSTALLATION_FOLDER\vimfiles` on windows).
17+
You should have 3 sub-directories in this runtime directory now: "autoload",
18+
"doc" and "plugin".
1919

20-
- Install as a Vim 8 plugin. Note `local` can be any name, but some path
21-
element must be present. On Windows, instead of `~/.vim` use
22-
`$VIM_INSTALLATION_FOLDER\vimfiles`.
20+
### Install as Vim8 plugin
21+
22+
Install as a Vim 8 plugin. Note `local` can be any name, but some path
23+
element must be present. On Windows, instead of `~/.vim` use
24+
`$VIM_INSTALLATION_FOLDER\vimfiles`.
2325
```shell
2426
mkdir -p ~/.vim/pack/local/start
2527
cd ~/.vim/pack/local/start
2628
git clone https://github.com/editorconfig/editorconfig-vim.git
2729
```
2830

29-
OR
31+
### Install with [pathogen][]
32+
33+
Use pathogen (the git repository of this plugin is
34+
https://github.com/editorconfig/editorconfig-vim.git)
3035

31-
- Use [pathogen][] (the git repository of this plugin is
32-
https://github.com/editorconfig/editorconfig-vim.git)
36+
### Install with [Vundle][]
3337

34-
OR
38+
Use Vundle by adding to your `.vimrc` Vundle plugins section:
3539

36-
- Use [Vundle][] by adding to your `.vimrc` Vundle plugins section:
40+
```viml
41+
Plugin 'editorconfig/editorconfig-vim'
42+
```
3743

38-
```viml
39-
Plugin 'editorconfig/editorconfig-vim'
40-
```
44+
Then remember to call `:PluginInstall`.
4145

42-
Then remember to call `:PluginInstall`.
46+
### Install with [vim-plug][]
47+
48+
Use vim-plug by adding to your `.vimrc` in your plugin section:
49+
50+
```viml
51+
Plug 'editorconfig/editorconfig-vim'
52+
```
53+
54+
Then remember to call `:PlugInstall`.
4355

4456
### No external editorconfig core library is required
4557

@@ -118,3 +130,4 @@ Feel free to submit bugs, feature requests, and other issues to the
118130
[pathogen]: https://github.com/tpope/vim-pathogen
119131
[properties]: http://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties
120132
[editorconfig.txt]: https://github.com/editorconfig/editorconfig-vim/blob/master/doc/editorconfig.txt
133+
[vim-plug]: https://github.com/junegunn/vim-plug

0 commit comments

Comments
 (0)