Dist::Z...::Readme(3)

📦
version 6.040 · 9 versions
, in fedora 44

💖 Dist::Z...::Readme — the manual page, but make it bestie 💖

okay so you found yourself on the Dist::Z...::Readme(3) page, part of the User Contributed Perl Documentation situation, and honestly? you're in the right place. this is the Dist::Zilla::Plugin::Readme doc. let's get into it 🫶

✨ NAME ✨

Dist::Zilla::Plugin::Readme — bestie, it builds a README file. that's the whole job. iconic. 💅

🎀 VERSION 🎀

version 6.040 ✨

🌸 DESCRIPTION 🌸

so basically this plugin drops a very simple README file into your distribution, and it flexes the dist's:

  • name
  • version
  • abstract
  • license

that's it, that's the content. and the manpage literally says it "may be more useful or informative in the future" — which is such a mood, we love a roadmap that's just vibes 😭

lowkey a humble little plugin. but it does exactly what it says on the tin, no cap.

🦋 PERL VERSION 🦋

okay this part matters, so lock in 🧚

this module should work on any version of perl still receiving updates from the Perl 5 Porters. which means it should work on any version of perl released in the last two to three years. (like — if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.) periodt.

and now the fine print, bestie:

  • it may work on older versions of perl, but no guarantee is made that the minimum required version won't get increased
  • the version may be increased for any reason
  • and there is no promise that patches will be accepted to lower the minimum required perl
read that again. they said "for any reason." they meant it. 🙈

💜 AUTHOR 💜

Ricardo SIGNES 😏 <cpan@semiotic.systems>

(the 😏 is canon. it's in the original. we are simply respecting the source material 👑)

This software is copyright (c) 2026 by Ricardo SIGNES.

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 💖

and that's the whole page, bestie!! no crumbs left, every detail accounted for 🎀

perl v5.42.3 — 2026-10-19 — Dist::Z...::Readme(3)

mwah, thanks for reading, go build that README 💅✨

📦 where this page comes from