Module::Install::ReadmeMarkdownFromPod(3pm)

1Module::Install::ReadmeUMsaerrkdCoownntFrriobmuPtoeddM(o3Pd)eurlle:D:oIcnusmteanltla:t:iRoenadmeMarkdownFromPod(3)
2
3
4

NAME

6       Module::Install::ReadmeMarkdownFromPod - create README.mkdn from POD
7

SYNOPSIS

9           # in Makefile.PL
10           use inc::Module::Install;
11           name 'Some-Module';
12           readme_markdown_from 'lib/Some/Module.pm';
13

DESCRIPTION

15       Module::Install::ReadmeMarkdownFromPod is a Module::Install extension
16       that generates a "README.mkdn" file automatically from an indicated
17       file containing POD whenever the author runs "Makefile.PL". This file
18       is used by GitHub to display nicely formatted information about a
19       repository.
20

FUNCTIONS

22       "readme_markdown_from"
23           Does nothing on the user-side. On the author-side it will generate
24           a "README.mkdn" file using Pod::Markdown from the POD in the file
25           passed as a parameter.
26
27               readme_markdown_from 'lib/Some/Module.pm';
28
29           If a second parameter is set to a true value then the "README.mkdn"
30           will be removed at "make distclean".
31
32               readme_markdown_from 'lib/Some/Module.pm' => 'clean';
33
34           It will die unless a file name is given.
35
36       "readme_markdown_from_pod"
37           Like "readme_markdown_from" but assumes that "all_from" has been
38           called before and uses the filename stored there to generate the
39           "README.mkdn". It then calls "readme_markdown_from" with that
40           filename. If this function is given an optional boolean parameter,
41           that will be passed to "readme_markdown_from" as well, indicating
42           whether to clean up the generated "README.mkdn" file at "make
43           distclean" time.
44
45       "readme_from_pod"
46           Like "readme_markdown_from_pod", but affects the plain-text
47           "README" file generation done in Module::Install::ReadmeFromPod.
48           This function would be better placed in that module and might move
49           there eventually. It is given here as a convenience because if you
50           want to generate both "README" and "README.mkdn" you can do this
51           here without repeating the filename given in "all_from".
52
53       "reference_module"
54           A utility function that saves you from repeatedly naming a
55           reference module from which to extract information.
56
57               reference_module 'lib/Some/Module.pm';
58
59           is equivalent to:
60
61               all_from 'lib/Some/Module.pm';
62               readme_from 'lib/Some/Module.pm';
63               readme_markdown_from 'lib/Some/Module.pm';
64
65           It will die unless a file name is given. Note that
66           "reference_module" will not work with Shipit::Step::FindVersion
67           because that module is looking for a "version_from" or "all_from"
68           string in "Makefile.PL"
69

BUGS AND LIMITATIONS

71       No bugs have been reported.
72
73       Please report any bugs or feature requests through the web interface at
74       <http://rt.cpan.org>.
75

INSTALLATION

77       See perlmodinstall for information and options on installing Perl
78       modules.
79

AVAILABILITY

81       The latest version of this module is available from the Comprehensive
82       Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find
83       a CPAN site near you. Or see
84       <http://search.cpan.org/dist/Module-Install-ReadmeMarkdownFromPod/>.
85
86       The development version lives at
87       <http://github.com/hanekomu/module-install-readmemarkdownfrompod/>.
88       Instead of sending patches, please fork this project using the standard
89       git and github infrastructure.
90

AUTHORS

92       Marcel Grünauer, "<marcel@cpan.org>"
93

COPYRIGHT AND LICENSE

95       Copyright 2009 by Marcel Grünauer
96
97       This library is free software; you can redistribute it and/or modify it
98       under the same terms as Perl itself.
99