On Sep 2, 2013 2:04 PM, "Marc Weber" <[email protected]> wrote: > > Today you should > - write a doc/*.txt file (for vim's internal help command and browser) > - a README(.rst/.rd) document for github > - install/ usage instructions for www.vim.org site (if you choose to > upload your plugin)
You are a programmer! You should: - For each plugin write doc/*.txt. Write README contents and installation instructions somewhere here (I write README in the intro section: typically the first one; installation instructions are same for all plugins). - Write *once* a script that will transform intro section into README and vim.org description. It may also contain installation instructions for all plugins since they are the same. Mine is here: sourceforge.net/p/vimpluginloader/dev-tools/ci/default/tree/pkgdo.pl. > Yes - this means duplication. And yes, I would have liked to improve > this for a long time, but never had time to actually do so :( > > About doc/*.txt files: What is important to the user? > use links and references and make appearance close to what others do. > Eg look at :h. > > Marc Weber > > -- > -- > 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 > > --- > You received this message because you are subscribed to the Google Groups "vim_use" group. > To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. > For more options, visit https://groups.google.com/groups/opt_out. -- -- 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 --- You received this message because you are subscribed to the Google Groups "vim_use" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/groups/opt_out.
