Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bigpresh/pod-readme
Pod::Readme - produce a README file from POD
https://github.com/bigpresh/pod-readme
Last synced: about 2 months ago
JSON representation
Pod::Readme - produce a README file from POD
- Host: GitHub
- URL: https://github.com/bigpresh/pod-readme
- Owner: bigpresh
- Created: 2010-04-13T21:16:44.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2021-11-01T16:01:04.000Z (about 3 years ago)
- Last Synced: 2024-10-13T11:32:29.605Z (2 months ago)
- Language: Perl
- Homepage: http://search.cpan.org/dist/Pod-Readme
- Size: 351 KB
- Stars: 8
- Watchers: 5
- Forks: 12
- Open Issues: 11
-
Metadata Files:
- Readme: README.pod
- Changelog: Changes
Awesome Lists containing this project
README
=head1 NAME
Pod::Readme - Intelligently generate a README file from POD
=head1 VERSION
v1.2.0
=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
=item * L
=item * L
=item * L
=item * L
=item * L
=item * L
=item * L
=item * L
=item * L
=item * L
=item * L
=back
=head1 RECENT CHANGES
=head2 Bug Fixes
=over 4
=item *
Specify minimum version of List::Util, GH#22.
=back
=head2 Enhancements
=over 4
=item *
Added "md" as an alias for "markdown" in pod2readme.
=back
=head2 Incompatabilities
=over 4
=item *
Removed DistZilla type from Pod::Readme::Types, as it was not necessary.
=back
=head2 Toolchain
=over 4
=item *
Remove use of Module::Install, fixes GH#21.
=item *
Use Dist::Zilla to build the distribution.
=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.