Skip to content

Commit d0647d6

Browse files
committed
Add help tag generation steps to README, closes #67
For non-vundle users, give steps to generating help tags for Vdebug vim help.
1 parent 84fae34 commit d0647d6

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,25 @@ To get this help, type:
3838
:help Vdebug
3939
```
4040

41-
after installing the plugin.
41+
after installing the plugin. If this doesn't work, you will need to generate the help tags.
42+
43+
## Generating help tags
44+
45+
Some package managers, such as Vundle, will automatically generate help tags. Others, such as Pathogen, won't by default, so you have to do it yourself. Also, if you have installed Vdebug manually then you will also have to do this step.
46+
47+
For pathogen users, you can add this to your vimrc file to automatically generate helptags for your plugins:
48+
49+
```vim
50+
call pathogen#helptags()
51+
```
52+
53+
To manually generate the tags, run this in vim:
54+
55+
```vim
56+
:helptags /path/to/vdebug/doc
57+
```
58+
59+
where the path supplied is vdebug's doc directory. This should enable vdebug's help to be accessed.
4260

4361
# Installation
4462

0 commit comments

Comments
 (0)