Scroll to navigation

Dist::Zilla::Plugin::InstallGuide(3pm) User Contributed Perl Documentation Dist::Zilla::Plugin::InstallGuide(3pm)

NAME

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

VERSION

version 1.200012

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.

METHODS

gather_files

Creates the INSTALL file.

munge_files

Inserts the appropriate installation instructions into INSTALL.

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>.

AUTHORS

  • Marcel Gruenauer <marcel@cpan.org>
  • Mike Doherty <doherty@cpan.org>

CONTRIBUTORS

  • Mike Doherty <mike@mikedoherty.ca>
  • Karen Etheridge <ether@cpan.org>
  • Marcel Gruenauer <hanekomu@gmail.com>
  • jonasbn <jonasbn@gmail.com>
  • Mike Doherty <doherty@cs.dal.ca>
  • Dan Book <grinnz@gmail.com>
  • Dave Rolsky <autarch@urth.org>
  • Apocalypse <APOCAL@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Marcel Gruenauer <marcel@cpan.org>.

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

2018-11-04 perl v5.28.0