NAME

Dist::Zilla::Plugin::InstallGuide - Build an INSTALL file

VERSION

version 1.101461

SYNOPSIS

In dist.ini:

    [InstallGuide]

DESCRIPTION

This plugin adds a very simple INSTALL file to the distribution, telling the user how to install this distribution.

You should use this plugin in your Dist::Zilla configuration after [MakeMaker] or [ModuleBuild] so that it can determine what kind of distribution you are building and which installation instructions are appropriate.

FUNCTIONS

setup_installer

Builds and writes the INSTALL file.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests through the web interface at http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-InstallGuide.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit http://www.perl.com/CPAN/ to find a CPAN site near you, or see http://search.cpan.org/dist/Dist-Zilla-Plugin-InstallGuide/.

The development version lives at http://github.com/hanekomu/Dist-Zilla-Plugin-InstallGuide/. Instead of sending patches, please fork this project using the standard git and github infrastructure.

AUTHOR

  Marcel Gruenauer <marcel@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Marcel Gruenauer.

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