Skip to content

Commit 798d1f4

Browse files
committed
Update README.md for 'filetype' and 'syntax on' requirements
1 parent 19d5b33 commit 798d1f4

File tree

1 file changed

+47
-22
lines changed

1 file changed

+47
-22
lines changed

README.md

Lines changed: 47 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,53 @@ Some things may not work on earlier versions.
88

99
## Installation
1010

11-
Use one of the following package managers:
12-
13-
* [Vim8 packages][vim8pack]:
14-
* `git clone https://github.com/rust-lang/rust.vim ~/.vim/pack/plugins/start/rust.vim`
15-
* [Vundle][v]:
16-
* Add `Plugin 'rust-lang/rust.vim'` to `~/.vimrc`
17-
* `:PluginInstall` or `$ vim +PluginInstall +qall`
18-
* *Note:* Vundle will not automatically detect Rust files properly if `filetype
19-
on` is executed before Vundle. Please check the [quickstart][vqs] for more
20-
details. Errors such as `Not an editor command: RustFmt` may occur if Vundle
21-
is misconfigured with this plugin.
22-
* [Pathogen][p]:
23-
* `git clone --depth=1 https://github.com/rust-lang/rust.vim.git ~/.vim/bundle/rust.vim`
24-
* [vim-plug][vp]:
25-
* Add `Plug 'rust-lang/rust.vim'` to `~/.vimrc`
26-
* `:PlugInstall` or `$ vim +PlugInstall +qall`
27-
* [dein.vim][d]:
28-
* Add `call dein#add('rust-lang/rust.vim')` to `~/.vimrc`
29-
* `:call dein#install()`
30-
* [NeoBundle][nb]:
31-
* Add `NeoBundle 'rust-lang/rust.vim'` to `~/.vimrc`
32-
* Re-open vim or execute `:source ~/.vimrc`
11+
For activating the full functionality, this plugin requires either the plugin
12+
manager or the `.vimrc` to have the following:
13+
14+
```vim
15+
syntax enable
16+
filetype plugin indent on
17+
```
18+
19+
Most plugin managers don't do this automatically, so these statements are
20+
usually added by users in their `vimrc` _right after_ the plugin manager load
21+
section.
22+
23+
### [Vim8 packages][vim8pack]
24+
25+
```sh
26+
git clone https://github.com/rust-lang/rust.vim ~/.vim/pack/plugins/start/rust.vim
27+
```
28+
29+
### [Vundle][v]
30+
31+
```vim
32+
Plugin 'rust-lang/rust.vim'
33+
```
34+
35+
### [Pathogen][p]
36+
37+
```sh
38+
git clone --depth=1 https://github.com/rust-lang/rust.vim.git ~/.vim/bundle/rust.vim
39+
```
40+
41+
### [vim-plug][vp]
42+
43+
```vim
44+
Plug 'rust-lang/rust.vim'
45+
```
46+
47+
### [dein.vim][d]
48+
49+
```vim
50+
call dein#add('rust-lang/rust.vim')
51+
```
52+
53+
### [NeoBundle][nb]
54+
55+
```vim
56+
NeoBundle 'rust-lang/rust.vim'
57+
```
3358

3459
## Features
3560

0 commit comments

Comments
 (0)