perl-Pod-Readme

Convert POD to README file

This module is a subclass of L<Pod::PlainText> which provides additional POD markup for generating F<README> files. Why should one bother with this? One can simply use pod2text Module.pm > README A problem with doing that is that the default L<pod2text> converter will add text to links, so that "LZ<><Module>" is translated to "the Module manpage". Another problem is that the F<README> includes the entirety of the module documentation! Most people browsing the F<README> file do not need all of this information. Likewise, including installation and requirement information in the module documentation is not necessary either, since the module is already installed. This module allows authors to mark portions of the POD to be included only in, or to be excluded from the F<README> file. It also allows you to include portions of another file (such as a separate F<ChangeLog>).