Skip to content

Commit da84f71

Browse files
committed
README: Update Installation instructions
1 parent 977ba05 commit da84f71

File tree

1 file changed

+63
-26
lines changed

1 file changed

+63
-26
lines changed

README.md

Lines changed: 63 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,55 +5,89 @@ shipped with Vim for the Erlang programming language.
55

66
## Installation
77

8-
### Installing manually
8+
<details>
9+
<summary>Vim's built-in package manager</summary>
910

10-
1. Clone this repository:
11+
This is the recommended installation method if you use at least Vim 8 and you
12+
don't use another package manager.
1113

12-
```
13-
$ mkdir -p ~/.vim/bundle
14-
$ cd ~/.vim/bundle
15-
$ git clone https://github.com/vim-erlang/vim-erlang-runtime
16-
```
14+
Information about Vim's built-in package manager: [`:help packages`].
1715

18-
2. Add the repository path to `runtimepath` in your `.vimrc`:
16+
Installation steps:
1917

20-
```
21-
:set runtimepath^=~/.vim/bundle/vim-erlang-runtime/
22-
```
18+
1. Clone this repository (you can replace `foo` with the directory name of your
19+
choice):
2320

24-
### Installing manually, alternative method
25-
26-
1. Copy `syntax/erlang.vim` into `~/.vim/syntax/`.
21+
```sh
22+
$ git clone https://github.com/vim-erlang/vim-erlang-runtime.git \
23+
~/.vim/pack/foo/start/vim-erlang-runtime
24+
```
2725

28-
2. Copy `indent/erlang.vim` into `~/.vim/indent/`.
26+
2. Restart Vim.
27+
</details>
2928

30-
3. Copy `ftplugin/erlang.vim` into `~/.vim/ftplugin/`.
29+
<details>
30+
<summary>Pathogen</summary>
3131

32-
### Installing using vim-plug
32+
Information about Pathogen: [Pathogen repository].
3333

34-
1. Install vim-plug using the [instructions][vim-plug].
34+
Installation steps:
3535

36-
2. Add vim-erlang-runtime to your plugin list in `.vimrc` by inserting the
37-
following lines:
36+
1. Clone this repository:
3837

3938
```
40-
'' Erlang Runtime
41-
Plug 'vim-erlang/vim-erlang-runtime'
39+
$ git clone https://github.com/vim-erlang/vim-erlang-runtime.git \
40+
~/.vim/bundle/vim-erlang-runtime
4241
```
4342

44-
between
43+
2. Restart Vim.
44+
</details>
45+
46+
<details>
47+
<summary>Vundle</summary>
48+
49+
Information about Vundle: [Vundle repository].
50+
51+
Installation steps:
52+
53+
1. Add `vim-erlang-runtime` to your plugin list in `.vimrc` by inserting
54+
the line that starts with `Plugin`:
4555

4656
```
47-
call plug#begin('~/.vim/plugged')
57+
call vundle#begin()
58+
[...]
59+
Plugin 'vim-erlang/vim-erlang-runtime'
60+
[...]
61+
call vundle#end()
4862
```
4963

50-
and
64+
2. Restart Vim.
65+
66+
3. Run `:PluginInstall`.
67+
</details>
68+
69+
<details>
70+
<summary>Vim-Plug</summary>
71+
72+
Information about Vim-Plug: [vim-plug repository].
73+
74+
Installation steps:
75+
76+
1. Add `vim-erlang-runtime` to your plugin list in `.vimrc` by inserting the
77+
line that starts with `Plug`:
5178

5279
```
80+
call plug#begin()
81+
[...]
82+
Plug 'vim-erlang/vim-erlang-runtime'
83+
[...]
5384
call plug#end()
5485
```
5586

87+
2. Restart Vim.
88+
5689
3. Run `:PlugInstall`.
90+
</details>
5791

5892
## Tips
5993

@@ -261,14 +295,16 @@ For more details, see the [vader][vader] repository.
261295
[`:help ftplugin`]: https://vimhelp.org/usr_41.txt.html#ftplugin
262296
[`:help indent-expression`]: https://vimhelp.org/indent.txt.html#indent-expression
263297
[`:help new-filetype-scripts`]: https://vimhelp.org/filetype.txt.html#new-filetype-scripts
298+
[`:help packages`]: https://vimhelp.org/repeat.txt.html#packages
264299
[`:help syntax`]: https://vimhelp.org/syntax.txt.html#syntax
265300
[`ftdetect/erlang.vim`]: ftdetect/erlang.vim
266301
[`ftplugin/erlang.vim`]: ftplugin/erlang.vim
267302
[`indent/erlang.vim`]: indent/erlang.vim
268303
[`syntax/erlang.vim`]: syntax/erlang.vim
269304
[`test`]: test
305+
[Pathogen repository]: https://github.com/tpope/vim-pathogen
270306
[vader]: https://github.com/junegunn/vader.vim
271-
[vim-plug]: https://github.com/junegunn/vim-plug
307+
[vim-plug repository]: https://github.com/junegunn/vim-plug
272308
[vim-src/runtime/compiler/erlang.vim]: https://github.com/vim/vim/blob/master/runtime/compiler/erlang.vim
273309
[vim-src/runtime/doc/syntax.txt]: https://github.com/vim/vim/blob/master/runtime/doc/syntax.txt
274310
[vim-src/runtime/filetype.vim]: https://github.com/vim/vim/blob/master/runtime/filetype.vim
@@ -279,3 +315,4 @@ For more details, see the [vader][vader] repository.
279315
[vim-src/runtime/synmenu.vim]: https://github.com/vim/vim/blob/master/runtime/synmenu.vim
280316
[vim-src/runtime/syntax/erlang.vim]: https://github.com/vim/vim/blob/master/runtime/syntax/erlang.vim
281317
[vim-src/src/testdir/test_filetype.vim]: https://github.com/vim/vim/blob/master/src/testdir/test_filetype.vim
318+
[Vundle repository]: https://github.com/VundleVim/Vundle.vim

0 commit comments

Comments
 (0)