Pod::R...equires(3pm)

💖 Pod::Readme::Plugin::requires — the tea ☕

okay bestie, sit down, we're talking about Pod::Readme::Plugin::requires (you'll see it squished down to Pod::R...equires in the terminal header, but that's just the header being dramatic, the real name is the long one 💅). It's a Pod::Readme plugin that pulls your module requirements into your README. no cap.

---

✨ SYNOPSIS ✨

=for readme plugin requires

that's it. that's the whole vibe. one line and you're iconic 🎀

---

🌸 DESCRIPTION 🌸

so this is a plugin for Pod::Readme and what it does is pull the module requirements out of the META.yml file and drop them into your README. slay.

but here's the catch, and it's a real one — because this whole thing depends on the META.yml file, you gotta generate your README after that file has been updated. order matters, bestie. if you generate the README first, you're gonna be showing stale info and that's not the moment 🙈

fr fr: META.yml first, README second. don't fight it.

---

🦋 ARGUMENTS 🦋

💜 from-file

=for readme plugin version from-file='MYMETA.yml'

by default it goes and extracts the version from the META.yml file. that's the default behaviour, it just knows where to look, main character energy honestly.

but if — for some reason — that file is living in a non-standard location, then you should specify it right here in this argument. tell it where your file is at, it's not a mind reader 💅

and now the plot twist: the file will be ignored if the zilla attribute is set. in that case it gets its metadata from the Dist::Zilla object instead — which makes sense, because the META.yml file might not even exist. iykyk ✨

💜 no-omit-core

by default, core modules for the version of Perl specified in the META.yml file are omitted from this list. so the list is already filtered, it's giving curated.

if you'd rather see all the requirements — every single one, no filtering, no skipping — then specify this option. let it show everything, we love a full disclosure moment 👑

💜 title

=for readme plugin version title='REQUIREMENTS'

this argument lets you change the title of the heading. want it to say something else? say it here. customise your little heart out 🎀

---

💀 KNOWN ISSUES 💀

• Trailing zeros in module versions may be dropped.

okay this one's a lil cursed. if you specify a minimum version of a module with a trailing zero, like 0.30, then it may end up shown as 0.3. not ideal, we know, it's just how it be 😭

the workaround is to specify the module version in your Makefile.PL as a string instead of a number:

requires(
  'CPAN::Changes' => '0.30',
  ...
);

quote it, string it, and it behaves. periodt 💅

---

and that's the whole page, bestie. requirements in, README out, no drama (except the trailing zeros thing, we don't talk about the trailing zeros thing).

---

this page shipped as part of perl v5.28.0, dated 2018-11-26, under the Pod::R...equires(3pm) header, from the User Contributed Perl Documentation 💖 go forth and generate your READMEs, queen 👑🌈