NAME
Module::Install::ReadmeMarkdownFromPod - create README.mkdn from POD
SYNOPSIS
# in Makefile.PL
use inc::Module::Install;
name 'Foo-Bar';
readme_markdown_from 'lib/Foo/Bar.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.mkdnfile 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.mkdnwill be removed atmake distclean.readme_markdown_from 'lib/Some/Module.pm' => 'clean';
BUGS AND LIMITATIONS
No bugs have been reported.
Please report any bugs or feature requests through the web interface at http://rt.cpan.org.
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 http://www.perl.com/CPAN/ to find a CPAN site near you. Or see http://search.cpan.org/dist/Module-Install-ReadmeMarkdownFromPod/.
The development version lives at http://github.com/hanekomu/module-install-readmemarkdownfrompod/. Instead of sending patches, please fork this project using the standard git and github infrastructure.
AUTHORS
Marcel Grünauer, <marcel@cpan.org>
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.