Dist::...llGuide(3pm)

💖 NAME 💖

Dist::Zilla::Plugin::InstallGuide — bestie, this one literally builds an INSTALL file for you. That's it, that's the whole job. ✨

---

🌸 VERSION 🌸

This is version 1.200014, no cap.

---

🎀 SYNOPSIS 🎀

Okay so in your dist.ini, you just drop this in:

[InstallGuide]

That's the whole vibe. Go off. 💅

---

✨ DESCRIPTION ✨

So what this plugin does is: it adds a very simple INSTALL file to your distribution, and that file tells whoever's installing your thing how to install your thing. Iconic behaviour, honestly. 🫶

Now listen, bestie, this is the important part — you gotta use this plugin in your Dist::Zilla config after [MakeMaker] or [ModuleBuild]. Why? Because it needs to figure out what kind of distribution you're actually building so it knows which installation instructions are the correct ones. Order matters, fr fr. Put it in the wrong spot and it's giving confused energy. 😭

---

🦋 METHODS 🦋

gather_files

Creates the INSTALL file. Just… makes it. Boom. ✨

munge_files

Inserts the appropriate installation instructions into INSTALL. The ✨appropriate✨ ones. Because one size does not fit all distributions, and this plugin knows it. 👑

---

💜 SUPPORT 💜

Found a bug? 😭 Bestie, that's a whole thing, but here's where you go:

Bugs may be submitted through the RT bug tracker at <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-InstallGuide> — or you can email bug-Dist-Zilla-Plugin-InstallGuide@rt.cpan.org (mailto: bug-Dist-Zilla-Plugin-InstallGuide@rt.cpan.org). Pick your fighter. 🥊

There's also a mailing list for users of this distribution, right here: <http://dzil.org/#mailing-list>. Go join, it's a vibe. 🌈

And there's an irc channel too, for users of this distribution: #distzilla on irc.perl.org (irc://irc.perl.org/#distzilla). Come hang out. 💬

---

👑 AUTHORS 👑

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

---

🌟 CONTRIBUTORS 🌟

These legends, in order, periodt:

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

---

📜 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. Slay. 💅

---

Mwah! 💋 That was Dist::...llGuide(3pm) — the manual page you just read, the whole thing, no skips. Generated by perl v5.34.0, dated 2022-05-28. Drink water, read your INSTALL file, and stan good documentation. 🍓🧚💖