1Pod::Readme::Plugin::reUqsueirreCso(n3t)ributed Perl DocPuomde:n:tRaetaidomne::Plugin::requires(3)
2
3
4

NAME

6       Pod::Readme::Plugin::requires - Include requirements in README
7

SYNOPSIS

9         =for readme plugin requires
10

DESCRIPTION

12       This is a plugin for Pod::Readme that includes module requirements from
13       the META.yml file.
14
15       Because this depends on the META.yml file, the README should be
16       generated after that file has been updated.
17

ARGUMENTS

19   "from-file"
20         =for readme plugin version from-file='MYMETA.yml'
21
22       By default, it will extract the version from the META.yml file. If, for
23       some reason, this file is in a non-standard location, then you should
24       specify it here.
25
26       The file will be ignored if the "zilla" attribute is set, and instead
27       obtain metadata from the Dist::Zilla object (since the META.yml file
28       may not exist.)
29
30   "no-omit-core"
31       By default, core modules for the version of Perl specified in the
32       META.yml file are omitted from this list.  If you prefer to lise all
33       requirements, then specify this option.
34
35   "title"
36         =for readme plugin version title='REQUIREMENTS'
37
38       This argument allows you to change the title of the heading.
39

KNOWN ISSUES

41       •   Trailing zeros in module versions may be dropped.
42
43           If you specify a minimum version of a module with a trailing zero,
44           e.g. "0.30", then it may be shown as "0.3".  A workaround is to
45           specify the module version in your Makefile.PL as a string instead
46           of number:
47
48             requires(
49               'CPAN::Changes' => '0.30',
50               ...
51             );
52
53
54
55perl v5.36.0                      2023-01-20  Pod::Readme::Plugin::requires(3)
Impressum