Skip to content

Commit 6559e7b

Browse files
committed
Add README.md with a basic install/usage description.
1 parent ce672df commit 6559e7b

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
vimperator.vim
2+
==============
3+
4+
Official Vimperator syntax highlighting file.
5+
6+
Split out from
7+
[vimperator/vimperator-labs](https://github.com/vimperator/vimperator-labs/tree/48728a0947324fb7facb89e259e7db7f5cd6d612/vimperator/contrib/vim).
8+
9+
Installation
10+
------------
11+
12+
### Manual:
13+
14+
Place `ftdetect` and `syntax` in `$HOME/.vim` or equivalent.
15+
16+
### [Vundle](https://github.com/gmarik/vundle):
17+
18+
Add to `$MYVIMRC`, e.g. `$HOME/.vimrc`:
19+
20+
Plugin 'vimperator/vimperator.vim'
21+
22+
Install using `:PluginInstall`.
23+
24+
### [Pathogen](https://github.com/tpope/vim-pathogen):
25+
26+
Add as a bundle:
27+
28+
$ cd ~/.vim/bundle
29+
$ git clone https://github.com/vimperator/vimperator.vim.git
30+
31+
Ensure `pathogen#infect()` is present in `$MYVIMRC`.
32+
33+
Usage
34+
-----
35+
36+
Common Vimperator files will be detected automatically.
37+
38+
For anything else, use a modeline, i.e. `vim: ft=vimperator` as a comment.

0 commit comments

Comments
 (0)