View on
MetaCPAN
Kent Fredric > Dist-Zilla-Plugin-Readme-Brief-0.003002 > Dist::Zilla::Plugin::Readme::Brief

Download:
Dist-Zilla-Plugin-Readme-Brief-0.003002.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.003002   Source  

NAME ^

Dist::Zilla::Plugin::Readme::Brief - Provide a short simple README with just the essentials

VERSION ^

version 0.003002

SYNOPSIS ^

  [Readme::Brief]
  ; Override autodetected install method
  installer = eumm
  ; Override autodetected main_module or main_module.pod as a source
  source_file = lib/Path/To/Module.pm
  ; Override name to use for brief body
  description_label = WHAT IS THIS

DESCRIPTION ^

This provides a terse but informative README file for your CPAN distribution that contains just the essential details about your dist a casual consumer would want to know.

NOTE ^

This is still reasonably fresh code and reasonably experimental, and feature enhancements and bug fixes are actively desired.

However, bugs are highly likely to be encountered, especially as there are no tests.

MECHANICS ^

ATTRIBUTES ^

source_file

Determines the file that will be parsed for POD to populate the README from.

By default, it uses your main_module, except if you have a .pod file with the same basename and path as your main_module, in which case it uses that.

This parameter and associated .pod support is new in v0.003000

installer

Determines what installers to document in the INSTALLATION section.

By default, that section is determined based on the presence of certain files in your dist.

However, in the event you have multiple installers supported, manually specifying this attribute allows you to control which, or all, and the order.

  installer = eumm ; # only eumm

  installer = eumm
  installer = mb     ; EUMM shown first, MB shown second

  installer = mb
  installer = eumm   ; EUMM shown second, MB shown first

The verbiage however has not yet been cleaned up such that having both is completely lucid.

This parameter was introduced in version v0.002000

description_label

This case-insensitive attribute defines what =head1 node will be used for the description section of the brief.

By default, this is DESCRIPTION.

This parameter was introduced in version v0.003000

SEE ALSO ^

Here are some competing modules and how this module differs from them.

AUTHOR ^

Kent Fredric <kentnl@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2017 by Kent Fredric <kentfredric@gmail.com>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: