search

MarcWeber / vim-addon-manager

manage and install vim plugins (including their dependencies) in a sane way. If you have any trouble contact me. Usually I reply within 24 hours
Other
660 stars 59 forks source link

installation instructions #136

Closed danielb2 closed 10 years ago

danielb2 commented 10 years ago

it's seems ironic that there are now installation instructions for this plugin.

It surely isn't enough to just add the two lines to vim. Note for example that pathogen has a pretty good set of simple installation instructions.

MarcWeber commented 10 years ago

Review the doc/* section, especially the more verbose code telling you that plugins usually have documentation in either their README or the doc/* section. doc/* is the most common place to place documentation for Vim plugins. I totally agree that it sucks for plugin authors and users that there are 3 places to maintain: 1) README 2) doc/* (for :h command) 3) install instructions on vim.sf.net. If you have time and want to work on this let me know.

danielb2 commented 10 years ago

I'd think it's a write-once thing for the README. It's not going to change much is it? I generally treat doc/ for vim plugins as run-time documentation. :h isn't going to be useful until it's installed, and by that time you don't need to install it.

And if you have install instructions on vim.sf.net maybe you can just reference those in the README.md file?