RDoc

RDoc your Application

All gli-based applications include a "hidden" command named rdoc. When you execute this command, a file called yourapp.rdoc is created in the current directory. This contains an rdoc-formatted helpfile for your command line application. This can be useful in packaging your application to share with others. This is also the only place in which the long_desc values are currently used.

If your application has a README.rdoc already, you can simply add :include:yourapp.rdoc to the bottom and it will be included when you generate and publish your rdoc (note that it will not show up on github).