NAME
Pod::Readme - Intelligently generate a README file from POD
VERSION
v1.2.0
SYNOPSIS
In a module's POD:
=head1 NAME
MyApp - my nifty app
=for readme plugin version
=head1 DESCRIPTION
This is a nifty app.
=begin :readme
=for readme plugin requires
=head1 INSTALLATION
...
=end :readme
=for readme stop
=head1 METHODS
...Then from the command-line:
pod2readme lib/MyModule.pm READMEDESCRIPTION
This module filters POD to generate a README file, by using POD commands to specify which parts are included or excluded from the README file.
See the Pod::Readme documentation for more details on the POD syntax that this module recognizes.
See pod2readme for command-line usage.
INSTALLATION
See How to install CPAN modules.
Required Modules
This distribution requires Perl v5.10.1.
This distribution requires the following modules:
CPAN::Changes (version 0.30)
RECENT CHANGES
Bug Fixes
Specify minimum version of List::Util, GH#22.
Enhancements
Added "md" as an alias for "markdown" in pod2readme.
Incompatabilities
Removed DistZilla type from Pod::Readme::Types, as it was not necessary.
Toolchain
Remove use of Module::Install, fixes GH#21.
Use Dist::Zilla to build the distribution.
See the Changes file for a longer revision history.
CAVEATS
This module is intended to be used by module authors for their own modules. It is not recommended for generating README files from arbitrary Perl modules from untrusted sources.
SEE ALSO
See perlpod, perlpodspec and podlators.
AUTHORS
The original version was by Robert Rothenberg <rrwo@cpan.org> until 2010, when maintenance was taken over by David Precious <davidp@preshweb.co.uk>.
In 2014, Robert Rothenberg rewrote the module to use filtering instead of subclassing a POD parser.
Acknowledgements
Thanks to people who gave feedback and suggestions to posts about the rewrite of this module on http://blogs.perl.org.
Suggestions, Bug Reporting and Contributing
This module is developed on GitHub at http://github.com/bigpresh/Pod-Readme
LICENSE
Copyright (c) 2005-2014 Robert Rothenberg. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.