/ 
Dist-Zilla-Plugin-UsefulReadme-v0.5.1
/ Pod::Weaver::Section::Requirements

NAME

Pod::Weaver::Section::Requirements - generate POD with the runtime requirements

VERSION

version v0.5.1

SYNOPSIS

In the weaver.ini:

[Requirements]
header = REQUIREMENTS
region = :readme

Or in the dist.ini for Dist::Zilla:

[PodWeaver]
[%PodWeaver]
Requirements.header = REQUIREMENTS
Requirements.region = :readme

DESCRIPTION

This is a Pod::Weaver plugin to add a section with the runtime requirements.

CONFIGURATION OPTIONS

The header to use. It defaults to "REQUIREMENTS".

region

When set to a non-empty string, the section will be embedded in a POD region, e.g.

region = :readme

to make the region available for Dist::Zilla::Plugin::UsefulReadme or Pod::Readme.

metafile

A file that lists metadata about prerequisites. It defaults to cpanfile.

If this file exists in the distribution, then the text will recommend that users see that file.

all_modules

When true, this section will be added to all modules in the distribution, and not just the main module.

When false (default), this section will only be added to the main module.

guess_prereqs

If the runtime prerequisites are not available from Dist::Zilla, then when this attribute is true, this plugin will use Perl::PrereqScanner to guess the prerequisites.

This was added in version v0.4.4, and is now false by default. (Previous versions guessed automatically.)

KNOWN ISSUES

When this is used to insert a section into the POD of a module, that it will only show the requirements for that module, and not the requirements of all of the modules in distribution. To show the later, it must be run after the build phase from Dist::Zilla though a plugin such as Dist::Zilla::Plugin::UsefulReadme.

SEE ALSO

Pod::Weaver::Section::Requires

SUPPORT

Only the latest version of this module will be supported.

This module requires Perl v5.20 or later. Future releases may only support Perl versions released in the last ten years.

Reporting Bugs and Submitting Feature Requests

Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/perl-Dist-Zilla-Plugin-UsefulReadme/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

If the bug you are reporting has security implications which make it inappropriate to send to a public issue tracker, then see SECURITY.md for instructions how to report security vulnerabilities.

SOURCE

The development version is on github at https://github.com/robrwo/perl-Dist-Zilla-Plugin-UsefulReadme and may be cloned from git://github.com/robrwo/perl-Dist-Zilla-Plugin-UsefulReadme.git

AUTHOR

Robert Rothenberg <rrwo@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2025 by Robert Rothenberg.

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