view release on metacpan or  search on metacpan

README  view on Meta::CPAN

    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.

    If you want to generate the same README file in both the build
    directory and the root directory, simply generate it in the build
    directory and use the [CopyFilesFromBuild] plugin to copy it to the
    dist root.

 phase

    At what phase to generate the README file. Choices are:

    build

      (Default) This generates the README at 'after build' time. A new
      README will be generated each time you build the dist.

    release

      This generates the README at 'after release' time. Note that this is
      too late to get the file into the generated tarball, and is therefore
      incompatible with location = build. However, this is ideal if you are
      using location = root and only want to update the README upon each
      release of your module.

METHODS

 gather_files

    We create the file early, so other plugins that need to have the full
    list of files are aware of what we will be generating.

 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. (The alternative is that the user doesn't add them to the build in
    the first place, with an option to their GatherDir plugin.)

 munge_files

 munge_file

    Edits the content into the requested README file in the dist.

 after_build

    Create the requested README file at build time, if requested.

 after_release

    Create the requested README file at release time, if requested.

 get_readme_content

    Get the content of the README in the desired format.

BUGS AND LIMITATIONS

    Please report any bugs or feature requests to
    rct+perlbug@thompsonclan.org.

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.

AUTHORS

      * Ryan C. Thompson <rct@thompsonclan.org>

      * Karen Etheridge <ether@cpan.org>

COPYRIGHT AND LICENSE

    This software is copyright (c) 2016 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.