NAME
Dist::Zilla::Plugin::ReadmeAnyFromPod - Automatically convert POD to a
README in any format for Dist::Zilla
VERSION
version 0.120051
SYNOPSIS
In your dist.ini
[ReadmeAnyFromPod]
; Default is plaintext README in build dir
; Using non-default options: POD format with custom filename in
; dist root, outside of build. Including this README in version
; control makes Github happy.
[ReadmeAnyFromPod / ReadmePodInRoot]
type = pod
filename = README.pod
location = root
; Using plugin name autodetection: Produces README.html in root
[ ReadmeAnyFromPod / HtmlInRoot ]
DESCRIPTION
Generates a README for your Dist::Zilla powered dist from its
"main_module" in any of several formats. The generated README can be
included in the build or created in the root of your dist for e.g.
inclusion into version control.
PLUGIN NAME AUTODETECTION
If you give the plugin an appropriate name (a string after the slash) in
your dist.ini, it will can parse the "type" and "location" attributes
from it. The format is "Readme[TYPE]In[LOCATION]". The words "Readme"
and "In" are optional, and the whole name is case-insensitive. The
SYNOPSIS section above gives one example.
ATTRIBUTES
type
The file format for the readme. Supported types are "text", "markdown",
"pod", and "html".
filename
The file name of the README file to produce. The default depends on the
selected format.
location
Where to put the generated README file. Choices are:
build
This puts the README in the directory where the dist is currently
being built, where it will be incorporated into the dist.
root
This puts the README in the root directory (the same directory that
contains dist.ini). The README will not be incorporated into the
built dist.
METHODS
prune_files
Files with "location = root" must also be pruned, so that they don't
sneak into the *next* build by virtue of already existing in the root
dir.
setup_installer
Adds the requested README file to the dist.
get_readme_content
Get the content of the README in the desired format.
BUGS AND LIMITATIONS
Please report any bugs or feature requests to
"
[email protected]".
SEE ALSO
* Dist::Zilla::Plugin::ReadmeFromPod - The base for this module
* Dist::Zilla::Plugin::ReadmeMarkdownFromPod - Functionality subsumed
by this module
* Dist::Zilla::Plugin::CopyReadmeFromBuild - Functionality partly
subsumed by this module
INSTALLATION
See perlmodinstall for information and options on installing Perl
modules.
AUTHOR
Ryan C. Thompson <
[email protected]>
COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by Ryan C. Thompson.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
