Dist::Zilla::Plugin::CopyReadmeFromBuild - Copy README after building (for SCM inclusion, etc.)
In your Dist::Zilla dist.ini:
CopyReadmeFromBuild will automatically copy the README from the build directory into the distribution directory. This is so you can commit the README to version control. GitHub, for example, likes to see a README
Dist::Zilla::Plugin::Readme will not like it if you already have a README, so you'll have to disable that plugin, an example of which is:
bundle = @Basic
remove = Readme
With the release of 0.0016, this plugin changed to performing the copy during the AfterRelease stage instead of the AfterBuild stage. To enable the old behavior, set the environment variable DZIL_CopyFromBuildAfterBuild to 1:
$ DZIL_CopyFromBuildAfterBuild=1 dzil build
Robert Krimen <firstname.lastname@example.org>
This software is copyright (c) 2011 by Robert Krimen.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Dist::Zilla::Plugin::CopyReadmeFromBuild, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.