1Dist::Zilla::Plugin::ReUasdemreFCroonmtProidb(u3t)ed PerDlisDto:c:uZmielnltaa:t:iPolnugin::ReadmeFromPod(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::ReadmeFromPod - dzil plugin to generate README
7       from POD
8

SYNOPSIS

10           # dist.ini
11           [ReadmeFromPod]
12
13           # or
14           [ReadmeFromPod]
15           filename = lib/XXX.pod
16           type = markdown
17           readme = READTHIS.md
18

DESCRIPTION

20       This plugin generates the README from "main_module" (or specified) by
21       Pod::Readme.
22
23   Options
24       The following options are supported:
25
26       "filename"
27
28       The name of the file to extract the README from. This defaults to the
29       main module of the distribution.
30
31       "type"
32
33       The type of README you want to generate. This defaults to "text".
34
35       Other options are "html", "pod", "markdown" and "rtf".
36
37       "pod_class"
38
39       This is the Pod::Simple class used to translate a file to the format
40       you want. The default is based on the "type" setting, but if you want
41       to generate an alternative type, you can set this option instead.
42
43       "readme"
44
45       The name of the file, which defaults to one based on the "type".
46
47   Conflicts with Other Plugins
48       We will remove the README created by Dist::Zilla::Plugin::Readme
49       automatically.
50

AUTHORS

52       Fayland Lam <fayland@gmail.com> and Ævar Arnfjörð Bjarmason
53       <avar@cpan.org>
54
55       Robert Rothenberg <rrwo@cpan.org> modified this plugin to use
56       Pod::Readme.
57

59       Copyright 2010-2014 Fayland Lam <fayland@gmail.com> and Ævar Arnfjörð
60       Bjarmason <avar@cpan.org>
61
62       This program is free software, you can redistribute it and/or modify it
63       under the same terms as Perl itself.
64
65
66
67perl v5.32.0                      2020-07-D2i8st::Zilla::Plugin::ReadmeFromPod(3)
Impressum