Dist-Zilla-Plugin-InstallGuide-1.200007/0000775000175000017500000000000012726753431016205 5ustar mikemikeDist-Zilla-Plugin-InstallGuide-1.200007/Makefile.PL0000644000175000017500000000353212726753431020160 0ustar mikemike# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.005. use strict; use warnings; use 5.008; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "Build an INSTALL file", "AUTHOR" => "Marcel Gr\x{fc}nauer , Mike Doherty ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0 }, "DISTNAME" => "Dist-Zilla-Plugin-InstallGuide", "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.008", "NAME" => "Dist::Zilla::Plugin::InstallGuide", "PREREQ_PM" => { "Dist::Zilla::File::InMemory" => 0, "Dist::Zilla::Role::FileGatherer" => 0, "Dist::Zilla::Role::FileMunger" => 0, "Dist::Zilla::Role::TextTemplate" => 0, "List::Util" => 0, "Moose" => 0, "strict" => 0, "warnings" => 0 }, "TEST_REQUIRES" => { "File::Spec" => 0, "IO::Handle" => 0, "IPC::Open3" => 0, "Path::Tiny" => 0, "Test::DZil" => 0, "Test::Fatal" => 0, "Test::More" => 0, "blib" => "1.01", "if" => 0 }, "VERSION" => "1.200007", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Dist::Zilla::File::InMemory" => 0, "Dist::Zilla::Role::FileGatherer" => 0, "Dist::Zilla::Role::FileMunger" => 0, "Dist::Zilla::Role::TextTemplate" => 0, "File::Spec" => 0, "IO::Handle" => 0, "IPC::Open3" => 0, "List::Util" => 0, "Moose" => 0, "Path::Tiny" => 0, "Test::DZil" => 0, "Test::Fatal" => 0, "Test::More" => 0, "blib" => "1.01", "if" => 0, "strict" => 0, "warnings" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); Dist-Zilla-Plugin-InstallGuide-1.200007/INSTALL0000644000175000017500000000207712726753431017242 0ustar mikemikeThis is the Perl distribution Dist-Zilla-Plugin-InstallGuide. Installing Dist-Zilla-Plugin-InstallGuide is straightforward. ## Installation with cpanm If you have cpanm, you only need one line: % cpanm Dist::Zilla::Plugin::InstallGuide If you are installing into a system-wide directory, you may need to pass the "-S" flag to cpanm, which uses sudo to install the module: % cpanm -S Dist::Zilla::Plugin::InstallGuide ## Installing with the CPAN shell Alternatively, if your CPAN shell is set up, you should just be able to do: % cpan Dist::Zilla::Plugin::InstallGuide ## Manual installation As a last resort, you can manually install it. Download the tarball, untar it, then build it: % perl Makefile.PL % make && make test Then install it: % make install If you are installing into a system-wide directory, you may need to run: % sudo make install ## Documentation Dist-Zilla-Plugin-InstallGuide documentation is available as POD. You can run perldoc from a shell to read the documentation: % perldoc Dist::Zilla::Plugin::InstallGuide Dist-Zilla-Plugin-InstallGuide-1.200007/t/0000775000175000017500000000000012726753431016450 5ustar mikemikeDist-Zilla-Plugin-InstallGuide-1.200007/t/01-basic.t0000644000175000017500000000273312726753431020137 0ustar mikemikeuse strict; use warnings FATAL => 'all'; use Test::More; use if $ENV{AUTHOR_TESTING}, 'Test::Warnings'; use Test::DZil; use Test::Fatal; use Path::Tiny; my $gathered_files; { package inc::MyGatherer; use Moose; with 'Dist::Zilla::Role::FileGatherer'; sub gather_files { my $self = shift; $gathered_files = $self->zilla->files; } } my $tzil = Builder->from_config( { dist_root => 't/does-not-exist' }, { add_files => { path(qw(source dist.ini)) => simple_ini( [ GatherDir => ], [ MakeMaker => ], [ InstallGuide => ], [ '=inc::MyGatherer' ], ), path(qw(source lib Foo.pm)) => "package Foo;\n1;\n", }, }, ); $tzil->chrome->logger->set_debug(1); is( exception { $tzil->build }, undef, 'build proceeds normally', ); my $build_dir = path($tzil->tempdir)->child('build'); my $file = $build_dir->child('INSTALL'); ok(-e $file, 'INSTALL created'); my $content = $file->slurp_utf8; unlike($content, qr/[^\S\n]\n/m, 'no trailing whitespace in generated file'); like($content, qr/Makefile.PL/m, 'INSTALL mentions Makefile.PL'); unlike($content, qr/Build.PL/m, 'INSTALL does not mention Build.PL'); ok( scalar(grep { $_->name eq 'INSTALL' } @$gathered_files), 'file was created at FileGathering time', ); diag 'got log messages: ', explain $tzil->log_messages if not Test::Builder->new->is_passing; done_testing; Dist-Zilla-Plugin-InstallGuide-1.200007/t/00-compile.t0000644000175000017500000000235312726753431020503 0ustar mikemikeuse 5.006; use strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::Compile 2.054 use Test::More; plan tests => 1 + ($ENV{AUTHOR_TESTING} ? 1 : 0); my @module_files = ( 'Dist/Zilla/Plugin/InstallGuide.pm' ); # no fake home requested my $inc_switch = -d 'blib' ? '-Mblib' : '-Ilib'; use File::Spec; use IPC::Open3; use IO::Handle; open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!"; my @warnings; for my $lib (@module_files) { # see L my $stderr = IO::Handle->new; my $pid = open3($stdin, '>&STDERR', $stderr, $^X, $inc_switch, '-e', "require q[$lib]"); binmode $stderr, ':crlf' if $^O eq 'MSWin32'; my @_warnings = <$stderr>; waitpid($pid, 0); is($?, 0, "$lib loaded ok"); shift @_warnings if @_warnings and $_warnings[0] =~ /^Using .*\bblib/ and not eval { require blib; blib->VERSION('1.01') }; if (@_warnings) { warn @_warnings; push @warnings, @_warnings; } } is(scalar(@warnings), 0, 'no warnings found') or diag 'got warnings: ', ( Test::More->can('explain') ? Test::More::explain(\@warnings) : join("\n", '', @warnings) ) if $ENV{AUTHOR_TESTING}; Dist-Zilla-Plugin-InstallGuide-1.200007/README.mkdn0000644000175000017500000000355512726753431020023 0ustar mikemike# NAME Dist::Zilla::Plugin::InstallGuide - Build an INSTALL file # VERSION version 1.200007 # SYNOPSIS In `dist.ini`: [InstallGuide] # DESCRIPTION This plugin adds a very simple `INSTALL` file to the distribution, telling the user how to install this distribution. You should use this plugin in your [Dist::Zilla](https://metacpan.org/pod/Dist::Zilla) configuration after `[MakeMaker]` or `[ModuleBuild]` so that it can determine what kind of distribution you are building and which installation instructions are appropriate. # METHODS ## gather\_files Creates the `INSTALL` file. ## munge\_files Inserts the appropriate installation instructions into `INSTALL`. # AVAILABILITY The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit [http://www.perl.com/CPAN/](http://www.perl.com/CPAN/) to find a CPAN site near you, or see [https://metacpan.org/module/Dist::Zilla::Plugin::InstallGuide/](https://metacpan.org/module/Dist::Zilla::Plugin::InstallGuide/). # SOURCE The development version is on github at [http://github.com/doherty/Dist-Zilla-Plugin-InstallGuide](http://github.com/doherty/Dist-Zilla-Plugin-InstallGuide) and may be cloned from [git://github.com/doherty/Dist-Zilla-Plugin-InstallGuide.git](git://github.com/doherty/Dist-Zilla-Plugin-InstallGuide.git) # BUGS AND LIMITATIONS You can make new bug reports, and view existing ones, through the web interface at [https://github.com/doherty/Dist-Zilla-Plugin-InstallGuide/issues](https://github.com/doherty/Dist-Zilla-Plugin-InstallGuide/issues). # AUTHORS - Marcel Grünauer - Mike Doherty # COPYRIGHT AND LICENSE This software is copyright (c) 2010 by Marcel Grünauer . This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Dist-Zilla-Plugin-InstallGuide-1.200007/LICENSE0000644000175000017500000004375712726753431017230 0ustar mikemikeThis software is copyright (c) 2010 by Marcel Grünauer . This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2010 by Marcel Grünauer . This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. 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 PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2010 by Marcel Grünauer . This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Dist-Zilla-Plugin-InstallGuide-1.200007/MANIFEST0000644000175000017500000000120112726753431017326 0ustar mikemike# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.005. Changes INSTALL LICENSE MANIFEST MANIFEST.SKIP META.json META.yml Makefile.PL README.mkdn dist.ini lib/Dist/Zilla/Plugin/InstallGuide.pm t/00-compile.t t/01-basic.t xt/author/critic.t xt/author/eol.t xt/author/mojibake.t xt/author/no-tabs.t xt/author/pod-coverage.t xt/author/pod-syntax.t xt/author/portability.t xt/author/synopsis.t xt/author/test-version.t xt/release/cpan-changes.t xt/release/dist-manifest.t xt/release/distmeta.t xt/release/kwalitee.t xt/release/meta-json.t xt/release/minimum-version.t xt/release/pod-linkcheck.t xt/release/unused-vars.t Dist-Zilla-Plugin-InstallGuide-1.200007/META.yml0000644000175000017500000000211012726753431017446 0ustar mikemike--- abstract: 'Build an INSTALL file' author: - 'Marcel Grünauer ' - 'Mike Doherty ' build_requires: File::Spec: '0' IO::Handle: '0' IPC::Open3: '0' Path::Tiny: '0' Test::DZil: '0' Test::Fatal: '0' Test::More: '0' blib: '1.01' if: '0' perl: '5.008' configure_requires: ExtUtils::MakeMaker: '0' perl: '5.008' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.005, CPAN::Meta::Converter version 2.150001' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Dist-Zilla-Plugin-InstallGuide no_index: directory: - corpus - examples - inc requires: Dist::Zilla::File::InMemory: '0' Dist::Zilla::Role::FileGatherer: '0' Dist::Zilla::Role::FileMunger: '0' Dist::Zilla::Role::TextTemplate: '0' List::Util: '0' Moose: '0' perl: '5.008' strict: '0' warnings: '0' resources: bugtracker: https://github.com/doherty/Dist-Zilla-Plugin-InstallGuide/issues repository: git://github.com/doherty/Dist-Zilla-Plugin-InstallGuide.git version: '1.200007' Dist-Zilla-Plugin-InstallGuide-1.200007/Changes0000644000175000017500000000315612726753431017503 0ustar mikemikeRevision history for Perl extension Dist-Zilla-Plugin-InstallGuide 1.200007 2016-06-11 - Updated text to suggest local::lib, and not recommend sudo [gh-9] 1.200006 2015-01-08 - Don't import Moose::Autobox [gh-8; ether] 1.200005 2014-10-26 - revert phase change made in last release [gh-7] 1.200004 2014-10-25 - Enable subclasses to override installation instruction text [gh-4] - Run one phase later to ensure install tools have already run [gh-5] 1.200003 2014-04-29 - create file at in the GatherFiles phase and munge it with a FromCode file type, to ensure the file exists early enough that other plugins can see it 1.200002 2013-11-27 - Re-release with a compile test that won't hang on Windows (thanks, chorny) 1.200001 2013-09-27 - only mention one installer tool even if both are in use, and prefer Build.PL over Makefile.PL, just as cpan clients do 1.200000 2012-05-22 - New maintainer: Mike Doherty, doherty@cpan.org - Include instructions for both EUMM and MB if both install tools are shipped [RT #56350] 1.101461 2010-05-26 17:30:09 Europe/Vienna - Various small grammar and spelling tweaks. Also added mention of sudo. (thanks autarch) 1.101460 2010-05-26 10:12:15 Europe/Vienna - added support Module::Build - note cpanm as preferred installation method 1.101420 2010-05-22 17:05:12 Europe/Vienna - removed weaver.ini since that's handled in Dist::Zilla's [@MARCEL] now - removed unused variable 1.100701 2010-03-11 23:47:35 Europe/Vienna - it's not an "online" documentation (thanks avar) 1.100700 2010-03-11 14:35:45 Europe/Vienna - original version Dist-Zilla-Plugin-InstallGuide-1.200007/MANIFEST.SKIP0000644000175000017500000000210612726753431020100 0ustar mikemike #!start included /home/mike/perl5/perlbrew/perls/perl-5.18.1/lib/5.18.1/ExtUtils/MANIFEST.SKIP # Avoid version control files. \bRCS\b \bCVS\b \bSCCS\b ,v$ \B\.svn\b \B\.git\b \B\.gitignore\b \b_darcs\b \B\.cvsignore$ # Avoid VMS specific MakeMaker generated files \bDescrip.MMS$ \bDESCRIP.MMS$ \bdescrip.mms$ # Avoid Makemaker generated and utility files. \bMANIFEST\.bak \bMakefile$ \bblib/ \bMakeMaker-\d \bpm_to_blib\.ts$ \bpm_to_blib$ \bblibdirs\.ts$ # 6.18 through 6.25 generated this # Avoid Module::Build generated and utility files. \bBuild$ \b_build/ \bBuild.bat$ \bBuild.COM$ \bBUILD.COM$ \bbuild.com$ # Avoid temp and backup files. ~$ \.old$ \#$ \b\.# \.bak$ \.tmp$ \.# \.rej$ # Avoid OS-specific files/dirs # Mac OSX metadata \B\.DS_Store # Mac OSX SMB mount metadata files \B\._ # Avoid Devel::Cover and Devel::CoverX::Covered files. \bcover_db\b \bcovered\b # Avoid MYMETA files ^MYMETA\. #!end included /home/mike/perl5/perlbrew/perls/perl-5.18.1/lib/5.18.1/ExtUtils/MANIFEST.SKIP # Avoid archives of this distribution \bDist-Zilla-Plugin-InstallGuide-[\d\.\_]+ Dist-Zilla-Plugin-InstallGuide-1.200007/META.json0000644000175000017500000000511512726753431017626 0ustar mikemike{ "abstract" : "Build an INSTALL file", "author" : [ "Marcel Gr\u00fcnauer ", "Mike Doherty " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.005, CPAN::Meta::Converter version 2.150001", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Dist-Zilla-Plugin-InstallGuide", "no_index" : { "directory" : [ "corpus", "examples", "inc" ] }, "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0", "perl" : "5.008" } }, "develop" : { "requires" : { "English" : "0", "Pod::Coverage::TrustPod" : "0", "Test::CPAN::Changes" : "0.19", "Test::CPAN::Meta" : "0", "Test::CPAN::Meta::JSON" : "0.16", "Test::EOL" : "0", "Test::Kwalitee" : "1.21", "Test::Mojibake" : "0", "Test::More" : "0.96", "Test::NoTabs" : "0", "Test::Pod" : "1.41", "Test::Pod::Coverage" : "1.08", "Test::Pod::LinkCheck" : "0", "Test::Portability::Files" : "0", "Test::Synopsis" : "0", "Test::Vars" : "0", "Test::Version" : "1" } }, "runtime" : { "requires" : { "Dist::Zilla::File::InMemory" : "0", "Dist::Zilla::Role::FileGatherer" : "0", "Dist::Zilla::Role::FileMunger" : "0", "Dist::Zilla::Role::TextTemplate" : "0", "List::Util" : "0", "Moose" : "0", "perl" : "5.008", "strict" : "0", "warnings" : "0" } }, "test" : { "requires" : { "File::Spec" : "0", "IO::Handle" : "0", "IPC::Open3" : "0", "Path::Tiny" : "0", "Test::DZil" : "0", "Test::Fatal" : "0", "Test::More" : "0", "blib" : "1.01", "if" : "0", "perl" : "5.008" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/doherty/Dist-Zilla-Plugin-InstallGuide/issues" }, "repository" : { "type" : "git", "url" : "git://github.com/doherty/Dist-Zilla-Plugin-InstallGuide.git", "web" : "https://github.com/doherty/Dist-Zilla-Plugin-InstallGuide" } }, "version" : "1.200007" } Dist-Zilla-Plugin-InstallGuide-1.200007/xt/0000775000175000017500000000000012726753431016640 5ustar mikemikeDist-Zilla-Plugin-InstallGuide-1.200007/xt/release/0000775000175000017500000000000012726753431020260 5ustar mikemikeDist-Zilla-Plugin-InstallGuide-1.200007/xt/release/distmeta.t0000644000175000017500000000017212726753431022255 0ustar mikemike#!perl # This file was automatically generated by Dist::Zilla::Plugin::MetaTests. use Test::CPAN::Meta; meta_yaml_ok(); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/release/kwalitee.t0000644000175000017500000000027512726753431022254 0ustar mikemike# this test was generated with Dist::Zilla::Plugin::Test::Kwalitee 2.12 use strict; use warnings; use Test::More 0.88; use Test::Kwalitee 1.21 'kwalitee_ok'; kwalitee_ok(); done_testing; Dist-Zilla-Plugin-InstallGuide-1.200007/xt/release/minimum-version.t0000644000175000017500000000026712726753431023606 0ustar mikemike#!perl use Test::More; eval "use Test::MinimumVersion"; plan skip_all => "Test::MinimumVersion required for testing minimum versions" if $@; all_minimum_version_ok( qq{5.10.1} ); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/release/dist-manifest.t0000644000175000017500000000023012726753431023205 0ustar mikemike#!perl use Test::More; eval "use Test::DistManifest"; plan skip_all => "Test::DistManifest required for testing the manifest" if $@; manifest_ok(); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/release/pod-linkcheck.t0000644000175000017500000000053712726753431023163 0ustar mikemike#!perl use strict; use warnings; use Test::More; foreach my $env_skip ( qw( SKIP_POD_LINKCHECK ) ){ plan skip_all => "\$ENV{$env_skip} is set, skipping" if $ENV{$env_skip}; } eval "use Test::Pod::LinkCheck"; if ( $@ ) { plan skip_all => 'Test::Pod::LinkCheck required for testing POD'; } else { Test::Pod::LinkCheck->new->all_pod_ok; } Dist-Zilla-Plugin-InstallGuide-1.200007/xt/release/unused-vars.t0000644000175000017500000000036212726753431022720 0ustar mikemike#!perl use Test::More 0.96 tests => 1; eval { require Test::Vars }; SKIP: { skip 1 => 'Test::Vars required for testing for unused vars' if $@; Test::Vars->import; subtest 'unused vars' => sub { all_vars_ok(); }; }; Dist-Zilla-Plugin-InstallGuide-1.200007/xt/release/meta-json.t0000644000175000017500000000006412726753431022340 0ustar mikemike#!perl use Test::CPAN::Meta::JSON; meta_json_ok(); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/release/cpan-changes.t0000644000175000017500000000026312726753431022773 0ustar mikemike#!perl use strict; use warnings; use Test::More 0.96 tests => 2; use_ok('Test::CPAN::Changes'); subtest 'changes_ok' => sub { changes_file_ok('Changes'); }; done_testing(); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/author/0000775000175000017500000000000012726753431020142 5ustar mikemikeDist-Zilla-Plugin-InstallGuide-1.200007/xt/author/synopsis.t0000644000175000017500000000006012726753431022210 0ustar mikemike#!perl use Test::Synopsis; all_synopsis_ok(); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/author/eol.t0000644000175000017500000000047012726753431021105 0ustar mikemikeuse strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::EOL 0.18 use Test::More 0.88; use Test::EOL; my @files = ( 'lib/Dist/Zilla/Plugin/InstallGuide.pm', 't/00-compile.t', 't/01-basic.t' ); eol_unix_ok($_, { trailing_whitespace => 1 }) foreach @files; done_testing; Dist-Zilla-Plugin-InstallGuide-1.200007/xt/author/test-version.t0000644000175000017500000000063712726753431022775 0ustar mikemikeuse strict; use warnings; use Test::More; # generated by Dist::Zilla::Plugin::Test::Version 1.09 use Test::Version; my @imports = qw( version_all_ok ); my $params = { is_strict => 0, has_version => 1, multiple => 0, }; push @imports, $params if version->parse( $Test::Version::VERSION ) >= version->parse('1.002'); Test::Version->import(@imports); version_all_ok; done_testing; Dist-Zilla-Plugin-InstallGuide-1.200007/xt/author/critic.t0000644000175000017500000000043512726753431021604 0ustar mikemike#!perl use strict; use warnings; use Test::More; use English qw(-no_match_vars); eval "use Test::Perl::Critic"; plan skip_all => 'Test::Perl::Critic required to criticise code' if $@; Test::Perl::Critic->import( -profile => "perlcritic.rc" ) if -e "perlcritic.rc"; all_critic_ok(); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/author/pod-coverage.t0000644000175000017500000000033412726753431022700 0ustar mikemike#!perl # This file was automatically generated by Dist::Zilla::Plugin::PodCoverageTests. use Test::Pod::Coverage 1.08; use Pod::Coverage::TrustPod; all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' }); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/author/no-tabs.t0000644000175000017500000000043612726753431021673 0ustar mikemikeuse strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::NoTabs 0.15 use Test::More 0.88; use Test::NoTabs; my @files = ( 'lib/Dist/Zilla/Plugin/InstallGuide.pm', 't/00-compile.t', 't/01-basic.t' ); notabs_ok($_) foreach @files; done_testing; Dist-Zilla-Plugin-InstallGuide-1.200007/xt/author/portability.t0000644000175000017500000000027712726753431022675 0ustar mikemike#!perl use strict; use warnings; use Test::More; eval 'use Test::Portability::Files'; plan skip_all => 'Test::Portability::Files required for testing portability' if $@; run_tests(); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/author/mojibake.t0000644000175000017500000000015112726753431022103 0ustar mikemike#!perl use strict; use warnings qw(all); use Test::More; use Test::Mojibake; all_files_encoding_ok(); Dist-Zilla-Plugin-InstallGuide-1.200007/xt/author/pod-syntax.t0000644000175000017500000000025212726753431022432 0ustar mikemike#!perl # This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. use strict; use warnings; use Test::More; use Test::Pod 1.41; all_pod_files_ok(); Dist-Zilla-Plugin-InstallGuide-1.200007/dist.ini0000644000175000017500000000045112726753431017647 0ustar mikemikename = Dist-Zilla-Plugin-InstallGuide copyright_year = 2010 license = Perl_5 copyright_holder = Marcel Grünauer author = Marcel Grünauer author = Mike Doherty [@Author::DOHERTY] Dist-Zilla-Plugin-InstallGuide-1.200007/lib/0000775000175000017500000000000012726753431016753 5ustar mikemikeDist-Zilla-Plugin-InstallGuide-1.200007/lib/Dist/0000775000175000017500000000000012726753431017656 5ustar mikemikeDist-Zilla-Plugin-InstallGuide-1.200007/lib/Dist/Zilla/0000775000175000017500000000000012726753431020731 5ustar mikemikeDist-Zilla-Plugin-InstallGuide-1.200007/lib/Dist/Zilla/Plugin/0000775000175000017500000000000012726753431022167 5ustar mikemikeDist-Zilla-Plugin-InstallGuide-1.200007/lib/Dist/Zilla/Plugin/InstallGuide.pm0000644000175000017500000001232112726753431025106 0ustar mikemikeuse 5.008; use strict; use warnings; package Dist::Zilla::Plugin::InstallGuide; # ABSTRACT: Build an INSTALL file our $VERSION = '1.200007'; # VERSION use Moose; with 'Dist::Zilla::Role::FileGatherer'; with 'Dist::Zilla::Role::TextTemplate'; with 'Dist::Zilla::Role::FileMunger'; use List::Util 'first'; has template => (is => 'ro', isa => 'Str', default => <<'END_TEXT'); This is the Perl distribution {{ $dist->name }}. Installing {{ $dist->name }} is straightforward. ## Installation with cpanm If you have cpanm, you only need one line: % cpanm {{ $package }} If it does not have permission to install modules to the current perl, cpanm will automatically set up and install to a local::lib in your home directory. See the local::lib documentation (https://metacpan.org/pod/local::lib) for details on enabling it in your environment. ## Installing with the CPAN shell Alternatively, if your CPAN shell is set up, you should just be able to do: % cpan {{ $package }} ## Manual installation {{ $manual_installation }} ## Documentation {{ $dist->name }} documentation is available as POD. You can run perldoc from a shell to read the documentation: % perldoc {{ $package }} END_TEXT has makemaker_manual_installation => (is => 'ro', isa => 'Str', default => <<'END_TEXT'); As a last resort, you can manually install it. Download the tarball, untar it, then build it: % perl Makefile.PL % make && make test Then install it: % make install If your perl is system-managed, you can create a local::lib in your home directory to install modules to. For details, see the local::lib documentation: https://metacpan.org/pod/local::lib END_TEXT has module_build_manual_installation => (is => 'ro', isa => 'Str', default => <<'END_TEXT'); As a last resort, you can manually install it. Download the tarball, untar it, then build it: % perl Build.PL % ./Build && ./Build test Then install it: % ./Build install If your perl is system-managed, you can create a local::lib in your home directory to install modules to. For details, see the local::lib documentation: https://metacpan.org/pod/local::lib END_TEXT sub gather_files { my $self = shift; require Dist::Zilla::File::InMemory; $self->add_file(Dist::Zilla::File::InMemory->new({ name => 'INSTALL', content => $self->template, })); return; } sub munge_files { my $self = shift; my $zilla = $self->zilla; my $manual_installation = ''; my %installer = ( map { $_->isa('Dist::Zilla::Plugin::MakeMaker') ? ( 'Makefile.PL' => 1 ) : (), $_->does('Dist::Zilla::Role::BuildPL') ? ( 'Build.PL' => 1 ) : (), } @{ $zilla->plugins } ); if ($installer{'Build.PL'}) { $manual_installation .= $self->module_build_manual_installation; } elsif ($installer{'Makefile.PL'}) { $manual_installation .= $self->makemaker_manual_installation; } unless ($manual_installation) { $self->log_fatal('neither Makefile.PL nor Build.PL is present, aborting'); } (my $main_package = $zilla->name) =~ s!-!::!g; my $file = first { $_->name eq 'INSTALL' } @{ $zilla->files }; my $content = $self->fill_in_string( $file->content, { dist => \$zilla, package => $main_package, manual_installation => $manual_installation } ); $file->content($content); return; } __PACKAGE__->meta->make_immutable; no Moose; 1; __END__ =pod =encoding UTF-8 =head1 NAME Dist::Zilla::Plugin::InstallGuide - Build an INSTALL file =head1 VERSION version 1.200007 =for test_synopsis BEGIN { die "SKIP: synopsis isn't perl code" } =head1 SYNOPSIS In C: [InstallGuide] =head1 DESCRIPTION This plugin adds a very simple F file to the distribution, telling the user how to install this distribution. You should use this plugin in your L configuration after C<[MakeMaker]> or C<[ModuleBuild]> so that it can determine what kind of distribution you are building and which installation instructions are appropriate. =head1 METHODS =head2 gather_files Creates the F file. =head2 munge_files Inserts the appropriate installation instructions into F. =head1 AVAILABILITY The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit L to find a CPAN site near you, or see L. =head1 SOURCE The development version is on github at L and may be cloned from L =head1 BUGS AND LIMITATIONS You can make new bug reports, and view existing ones, through the web interface at L. =head1 AUTHORS =over 4 =item * Marcel Grünauer =item * Mike Doherty =back =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2010 by Marcel Grünauer . This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut