logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Authors

       •   Marcel Gruenauer <marcel@cpan.org>

       •   Mike Doherty <doherty@cpan.org>

Contributors

       •   Karen Etheridge <ether@cpan.org>

       •   Mike Doherty <mike@mikedoherty.ca>

       •   Marcel Gruenauer <hanekomu@gmail.com>

       •   jonasbn <jonasbn@gmail.com>

       •   Mike Doherty <doherty@cs.dal.ca>

       •   Dan Book <grinnz@gmail.com>

       •   Apocalypse <APOCAL@cpan.org>

       •   Dan Book <grinnz@grinnz.com>

       •   Dave Rolsky <autarch@urth.org>

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.

Methods

gather_files
       Creates the INSTALL file.

   munge_files
       Inserts the appropriate installation instructions into INSTALL.

Name

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

Support

       Bugs may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-
       Zilla-Plugin-InstallGuide> (or bug-Dist-Zilla-Plugin-InstallGuide@rt.cpan.org <mailto:bug-Dist-Zilla-
       Plugin-InstallGuide@rt.cpan.org>).

       There is also a mailing list available for users of this distribution, at
       <http://dzil.org/#mailing-list>.

       There is also an irc channel available for users of this distribution, at "#distzilla" on "irc.perl.org"
       <irc://irc.perl.org/#distzilla>.

Synopsis

       In "dist.ini":

           [InstallGuide]

Version

       version 1.200014

See Also