Re: plugin description / installation hints based on archive/repo?

Hi,

On Thursday, April 7, 2011 12:50:36 PM UTC+2, MarcWeber wrote:

What about making vim.sf.net either show the doc/plugin.txt
documentation file instead - or take a special file from the archive
such as:
doc/vim-sf-net-plugin-info.txt

Since the plugin's help file is doc/plugin.txt, I'd rather vote for doc/plugin_install.txt or install/plugin.txt.

BTW I always found it slightly dysfunctional to put installation information in the help file since being able to read the help file usually implies that you have already installed the plugin somehow.

Most installation instructions consist of two parts:
1. How to extract/copy files
2. Suggested additional configuration steps

In an ideal world, plugin authors would only have to write #2. In most cases, it should be able to deduce #1 from the file type and/or plugin type. I don't think there is much use in putting #2 on vim.sf.net. Maybe the plugin creation page could suggest a text block for the installation instructions based on the file type? Maybe vimball.vim could display install/plugin.txt after extraction?

Regards,
Tom

--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php