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

NAME

Pod::Weaver::Section::InstallationInstructions - generate POD with installation instructions

VERSION

version v0.5.1

SYNOPSIS

In the weaver.ini:

[InstallationInstructions]
header  = INSTALLATION
builder = Makefile.PL
region  = :readme

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

[PodWeaver]
[%PodWeaver]
InstallationInstructions.header  = INSTALLATION
InstallationInstructions.builder = Makefile.PL
InstallationInstructions.region  = :readme

DESCRIPTION

This is a Pod::Weaver plugin to add a section with installation instructions.

The installation instructions will look something like

INSTALLATION

The latest version of this module (along with any dependencies) can be
installed from CPAN <https://www.cpan.org> with the cpan tool that is
included with Perl:

    cpan Pod::Weaver::Section::InstallationInstructions

You can also extract the distribution archive and install this module
(along with any dependencies):

    cpan .

You can also install this module manually using the following commands:

    perl Makefile.PL
    make
    make test
    make install

If you are working with the source repository, then it may not have a
Makefile.PL file. But you can use the Dist::Zilla <https://dzil.org/>
tool in anger to build and install this module:

    dzil build
    dzil test
    dzil install --install-command="cpan ."

For more information, see How to install CPAN modules
<https://www.cpan.org/modules/INSTALL.html>.

The actual text will depend on how it is configured, and what files are in the distribution.

CONFIGURATION OPTIONS

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

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.

builder

This indicates the kind of builder used, either Makefile.PL from ExtUtils::MakeMaker or Build.PL from Module::Build and variants.

If unset, it will attempt to guess. If it cannot guess, the instructions will be omitted.

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.

SEE ALSO

Pod::Weaver::Section::Installation

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.