23 Aug 2011 18:49:38 UTC
- Distribution: Dist-Zilla-Plugin-CopyReadmeFromBuild
- Module version: 0.0019
- Source (raw)
- Browse (raw)
- How to Contribute
- Issues (3)
- Testers (4108 / 1 / 0)
- KwaliteeBus factor: 0
- 34.15% Coverage
- License: perl_5
- Activity24 month
- Download (2.13KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionROKR Robert Krimenand 1 contributors
- Robert Krimen
Dist::Zilla::Plugin::CopyReadmeFromBuild - Copy README after building (for SCM inclusion, etc.)
In your Dist::Zilla
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:
[@Filter] 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.
Module Install Instructions
To install Dist::Zilla::Plugin::CopyReadmeFromBuild, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Dist::Zilla::Plugin::CopyReadmeFromBuild
For more information on module installation, please visit the detailed CPAN module installation guide.