Pod::Readme::Brief - A short simple README with just the essentials
my $readme = Pod::Readme::Brief->new( do { open my $fh, '<', __FILE__ or die $!; readline $fh; } ); my $installer = -e 'Makefile.PL' ? 'eumm' : -e 'Build.PL' ? 'mb' : undef; print $readme->render( installer => $installer );
This module creates a brief README from a POD document (presumably the main module of a distribution) with just the information relevant to the audience who would even look inside such a README: non-Perl people. This is intended as a sensible boilerplate generated README, unlike the usual tick-the-box approaches that do not actually help anyone (such as just converting the entire documentation of the the main module to text, or putting in just the name and abstract of the distribution).
The following information goes into such a README:
The NAME of the module
NAME
The content of the DESCRIPTION section
DESCRIPTION
Simple installation instructions
The content of the LICENSE section
LICENSE
new
Creates an instance of the class from a list of lines, which must contain a well-formed full POD document, either by itself or embedded in Perl code.
render
Renders the README. Takes the following named arguments:
installer
Specifies what manual installation instructions should be included, if any. (Instructions involving a CPAN client are always included.)
The value may be one of eumm (for a distribution using Makefile.PL), mb (for a distribution using Build.PL), or a false value (to omit manual installation instructions).
eumm
Makefile.PL
mb
Build.PL
Dist::Zilla::Plugin::Readme::Brief
Aristotle Pagaltzis <pagaltzis@gmx.de>
This software is copyright (c) 2018 by Aristotle Pagaltzis.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Pod::Readme::Brief, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Readme::Brief
CPAN shell
perl -MCPAN -e shell install Pod::Readme::Brief
For more information on module installation, please visit the detailed CPAN module installation guide.