| 1 | package Dist::Zilla::MintingProfile::Starter; | ||
| 2 | |||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | with 'Dist::Zilla::Role::MintingProfile::ShareDir'; | |
| 5 | 1 | ▶ | use namespace::clean; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 6 | |||
| 7 | 1 | our $VERSION = 'v6.0.2'; | |
| 8 | |||
| 9 | 1 | __PACKAGE__->meta->make_immutable; | |
| 10 | 1 | 1; | |
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Dist::Zilla::MintingProfile::Starter - A minimal Dist::Zilla minting profile | ||
| 15 | |||
| 16 | =head1 SYNOPSIS | ||
| 17 | |||
| 18 | # setup only needs to be run once to set up your dzil config | ||
| 19 | $ dzil setup | ||
| 20 | $ dzil new -P Starter My::New::Dist | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This minting profile for L<< C<dzil new>|Dist::Zilla::App::Command::new >> | ||
| 25 | creates a minimal new distribution consisting of a basic C<dist.ini> using the | ||
| 26 | L<[@Starter]|Dist::Zilla::PluginBundle::Starter> plugin bundle, and a skeleton | ||
| 27 | for the main module and its documentation. The author, license, and copyright | ||
| 28 | will be populated in the C<dist.ini> and documentation from the current dzil | ||
| 29 | C<config.ini>, which can be initialized using | ||
| 30 | L<< C<dzil setup>|Dist::Zilla::App::Command::setup >>. The version is | ||
| 31 | initialized statically as C<0.001>. | ||
| 32 | |||
| 33 | The L<Dist::Zilla::Starter> guide explains how the L<Dist::Zilla> plugin system | ||
| 34 | works, and how it is specifically used for the minting process. | ||
| 35 | |||
| 36 | See L<Dist::Zilla::MintingProfile::Starter::Git> for a version of this profile | ||
| 37 | designed for the L<[@Starter::Git]|Dist::Zilla::PluginBundle::Starter::Git> | ||
| 38 | bundle variant. | ||
| 39 | |||
| 40 | =head1 CUSTOMIZING | ||
| 41 | |||
| 42 | It's easy to create your own local version of this (or any other) minting | ||
| 43 | profile which you can customize as you choose. First create a new directory in | ||
| 44 | C<profiles> in your dzil configuration folder: | ||
| 45 | |||
| 46 | $ mkdir -p ~/.dzil/profiles/myminter | ||
| 47 | |||
| 48 | Then, copy the contents from the profile you want (such as the | ||
| 49 | C<profiles/default> directory of this distribution). Modify the copied files to | ||
| 50 | your liking, and then you can use it to mint a distribution. | ||
| 51 | |||
| 52 | $ dzil new -p myminter My::New::Dist | ||
| 53 | |||
| 54 | You can also specify a default provider (C<-P> option) or profile (C<-p> | ||
| 55 | option) in your dzil config (C<~/.dzil/config.ini>). | ||
| 56 | |||
| 57 | ; config.ini | ||
| 58 | [%Mint] | ||
| 59 | profile = myminter | ||
| 60 | |||
| 61 | ; or | ||
| 62 | [%Mint] | ||
| 63 | provider = Starter | ||
| 64 | |||
| 65 | $ dzil new My::New::Dist # now defaults to the specified provider and/or profile | ||
| 66 | |||
| 67 | If no provider or profile is configured or specified, C<dzil new> will use the | ||
| 68 | C<default> local profile, or the default C<[@Basic]> profile shipped with | ||
| 69 | L<Dist::Zilla>. | ||
| 70 | |||
| 71 | =head1 BUGS | ||
| 72 | |||
| 73 | Report any issues on the public bugtracker. | ||
| 74 | |||
| 75 | =head1 AUTHOR | ||
| 76 | |||
| 77 | Dan Book <dbook@cpan.org> | ||
| 78 | |||
| 79 | =head1 COPYRIGHT AND LICENSE | ||
| 80 | |||
| 81 | This software is Copyright (c) 2016 by Dan Book. | ||
| 82 | |||
| 83 | This is free software, licensed under: | ||
| 84 | |||
| 85 | The Artistic License 2.0 (GPL Compatible) | ||
| 86 | |||
| 87 | =head1 SEE ALSO | ||
| 88 | |||
| 89 | L<Dist::Zilla>, L<Dist::Zilla::PluginBundle::Starter> | ||