NAME Module::Install::ReadmeMarkdownFromPod - create README.mkdn from POD SYNOPSIS # in Makefile.PL use inc::Module::Install; name 'Some-Module'; readme_markdown_from 'lib/Some/Module.pm'; DESCRIPTION Module::Install::ReadmeMarkdownFromPod is a Module::Install extension that generates a "README.mkdn" file automatically from an indicated file containing POD whenever the author runs "Makefile.PL". This file is used by GitHub to display nicely formatted information about a repository. FUNCTIONS "readme_markdown_from" Does nothing on the user-side. On the author-side it will generate a "README.mkdn" file using Pod::Markdown from the POD in the file passed as a parameter. readme_markdown_from 'lib/Some/Module.pm'; If a second parameter is set to a true value then the "README.mkdn" will be removed at "make distclean". readme_markdown_from 'lib/Some/Module.pm' => 'clean'; It will die unless a file name is given. "readme_markdown_from_pod" Like "readme_markdown_from" but assumes that "all_from" has been called before and uses the filename stored there to generate the "README.mkdn". It then calls "readme_markdown_from" with that filename. If this function is given an optional boolean parameter, that will be passed to "readme_markdown_from" as well, indicating whether to clean up the generated "README.mkdn" file at "make distclean" time. "readme_from_pod" Like "readme_markdown_from_pod", but affects the plain-text "README" file generation done in Module::Install::ReadmeFromPod. This function would be better placed in that module and might move there eventually. It is given here as a convenience because if you want to generate both "README" and "README.mkdn" you can do this here without repeating the filename given in "all_from". "reference_module" A utility function that saves you from repeatedly naming a reference module from which to extract information. reference_module 'lib/Some/Module.pm'; is equivalent to: all_from 'lib/Some/Module.pm'; readme_from 'lib/Some/Module.pm'; readme_markdown_from 'lib/Some/Module.pm'; It will die unless a file name is given. Note that "reference_module" will not work with Shipit::Step::FindVersion because that module is looking for a "version_from" or "all_from" string in "Makefile.PL" BUGS AND LIMITATIONS No bugs have been reported. Please report any bugs or feature requests through the web interface at . INSTALLATION See perlmodinstall for information and options on installing Perl modules. AVAILABILITY The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit to find a CPAN site near you. Or see . The development version lives at . Instead of sending patches, please fork this project using the standard git and github infrastructure. AUTHORS Marcel Grünauer, "" COPYRIGHT AND LICENSE Copyright 2009 by Marcel Grünauer This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. SEE ALSO Pod::Markdown Module::Install Module::Install::ReadmeFromPod