The Perl Advent Calendar needs more articles for 2022. Submit your idea today!

NAME

Dist::Zilla::PluginBundle::Author::AJNN::Readme - Build a README file for AJNN's distributions

VERSION

version 0.03

DESCRIPTION

Provides a README file which only contains the most important information for someone who may have extracted the distribution archive, but is unsure what it is and what to do with it.

In particular, the following content is included in the README:

  • main module name

  • distribution version number

  • first paragraph of the distribution POD's description section (or the abstract, if the description can't be found or is empty)

  • URL of the distribution's home page on MetaCPAN

  • installation instructions (for both tools and manual)

  • author identification

  • license statement

It may be assumed that people who are already familiar with Perl and its ecosystem won't usually read the README accompanying a CPAN distribution. They typically get all they need to know from MetaCPAN, and are accustomed to cpanm and other tools. Non-Perl people, however, might not know how to install a Perl distribution or how to access the documentation. In my opinion, this is the information a CPAN distro README really needs to provide.

Identification of the module, on the other hand, may be kept very brief. A license file is included with the distribution, so stating the license is generally not required; however, this plugin will pick up any mangling done by Pod::Weaver::PluginBundle::Author::AJNN::License.

ATTRIBUTES

cpan_release

Whether the distribution is available on "/www.cpan.org/ CPAN" in https:. The default is yes. If set to no, the link in the readme will be changed to GitHub and CPAN will no longer be mentioned in the installation instructions.

 cpan_release = 0

SEE ALSO

Dist::Zilla::PluginBundle::Author::AJNN

Pod::Weaver::PluginBundle::Author::AJNN::License

Dist::Zilla::Plugin::Readme

Dist::Zilla::Plugin::Readme::Brief

AUTHOR

Arne Johannessen <ajnn@cpan.org>

If you contact me by email, please make sure you include the word "Perl" in your subject header to help beat the spam filters.

COPYRIGHT AND LICENSE

Arne Johannessen has dedicated the work to the Commons by waiving all of his or her rights to the work worldwide under copyright law and all related or neighboring legal rights he or she had in the work, to the extent allowable by law.

Works under CC0 do not require attribution. When citing the work, you should not imply endorsement by the author.