=head1 NAME Pod::Readme - Intelligently generate a README file from POD =head1 VERSION v1.0.2 =head1 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 README =head1 DESCRIPTION This module filters POD to generate a F file, by using POD commands to specify which parts are included or excluded from the F file. See the L documentation for more details on the POD syntax that this module recognizes. See L for command-line usage. =head1 INSTALLATION See L. =head2 Required Modules This distribution requires Perl v5.10.1. This distribution requires the following modules: =over 4 =item * L =item * L (version 0.30) =item * L =item * L =item * L =item * L =item * L (version 1.004005) =item * L =item * L =item * L =item * L (version 0.018) =item * L =item * L =item * L =item * L =item * L =item * L =back This distribution recommends the following modules: =over 4 =item * L =item * L =item * L =item * L =back =head1 RECENT CHANGES =over 4 =item * No changes since v1.0.1_08, just a version bump for a release. =item * See the full list of changes since v1.0.0 for more details. =back =head2 Enhancements =over 4 =item * This is a complete rewrite, using modern Perl with Moo. =item * Added support for plugins, along with plugins to insert the module version, prerequisites and the latest changes. =item * Added the ability to generate a README in a variety of formats, such as POD, Markdown, HTML, RTF, etc. =item * Added command-line options to the pod2readme script, including the ability to specify the output format. =item * Switched to semantic versioning. =item * The documentation has been updated accordingly. =back =head2 Incompatabilities =over 4 =item * Perl v5.10.1 is required. =item * This is no longer a subclass of a POD parser, although it has some wrapper methods for compatability with software known to use it. =back See the F file for a longer revision history. =head1 CAVEATS This module is intended to be used by module authors for their own modules. It is not recommended for generating F files from arbitrary Perl modules from untrusted sources. =head1 SEE ALSO See L, L and L. =head1 AUTHORS The original version was by Robert Rothenberg until 2010, when maintenance was taken over by David Precious . In 2014, Robert Rothenberg rewrote the module to use filtering instead of subclassing a POD parser. =head2 Acknowledgements Thanks to people who gave feedback and suggestions to posts about the rewrite of this module on L. =head2 Suggestions, Bug Reporting and Contributing This module is developed on GitHub at L =head1 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.