1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
# NAME
Dist::Zilla::Plugin::ReadmeFromPod - dzil plugin to generate README from POD
# SYNOPSIS
# dist.ini
[ReadmeFromPod]
# or
[ReadmeFromPod]
filename = lib/XXX.pod
type = markdown
readme = READTHIS.md
# DESCRIPTION
This plugin generates the `README` from `main_module` (or specified)
by [Pod::Readme](https://metacpan.org/pod/Pod%3A%3AReadme).
## Options
The following options are supported:
### `filename`
The name of the file to extract the `README` from. This defaults to
the main module of the distribution.
### `type`
The type of `README` you want to generate. This defaults to "text".
Other options are "html", "pod", "markdown" and "rtf".
### `pod_class`
This is the [Pod::Simple](https://metacpan.org/pod/Pod%3A%3ASimple) class used to translate a file to the
format you want. The default is based on the ["type"](#type) setting, but if
you want to generate an alternative type, you can set this option
instead.
### `readme`
The name of the file, which defaults to one based on the ["type"](#type).
## Conflicts with Other Plugins
We will remove the README created by [Dist::Zilla::Plugin::Readme](https://metacpan.org/pod/Dist%3A%3AZilla%3A%3APlugin%3A%3AReadme) automatically.
# AUTHORS
Fayland Lam <fayland@gmail.com> and
var Arnfjr Bjarmason <avar@cpan.org>
Robert Rothenberg <rrwo@cpan.org> modified this plugin to use
[Pod::Readme](https://metacpan.org/pod/Pod%3A%3AReadme).
# LICENSE AND COPYRIGHT
Copyright 2010-2015 Fayland Lam <fayland@gmail.com> and var
Arnfjr Bjarmason <avar@cpan.org>
This program is free software, you can redistribute it and/or modify
it under the same terms as Perl itself.
|
