| 1 |
NAME |
| 2 |
Dist::Inkt - yet another distribution builder |
| 3 |
|
| 4 |
STATUS |
| 5 |
Experimental. |
| 6 |
|
| 7 |
DESCRIPTION |
| 8 |
Dist::Zilla didn't have the prerequisite amount of crazy for me, so I |
| 9 |
wrote this instead. |
| 10 |
|
| 11 |
Dist::Inkt itself does virtually nothing; it creates an empty directory, |
| 12 |
generates a MANIFEST file, and then wraps it all up into a gzipped |
| 13 |
tarball. But it provides various hooks along the way for subclasses to |
| 14 |
grab hold of. So the general idea is that you write a subclass of |
| 15 |
Dist::Inkt, which consumes various Moose::Roles to do the actual work of |
| 16 |
populating the distribution with files. |
| 17 |
|
| 18 |
As such, Dist::Inkt is not so much a distribution builder, as it is a |
| 19 |
framework for writing your own distribution builder. |
| 20 |
|
| 21 |
Several roles of varying utility are bundled with Dist::Inkt, as is |
| 22 |
Dist::Inkt::Profile::Simple, a subclass of Dist::Inkt which consumes most |
| 23 |
of these roles. |
| 24 |
|
| 25 |
COMPANIONS |
| 26 |
Dist::Inkt does just one thing - building the tarball from some checkout |
| 27 |
of the repo. |
| 28 |
|
| 29 |
Although roles could theoretically be written for other tasks, out of the |
| 30 |
box, Dist::Inkt doesn't do any of the following: |
| 31 |
|
| 32 |
Minting new distributions |
| 33 |
I'm writing a separate tool, Dist::Inktly::Minty for that. |
| 34 |
|
| 35 |
Test suite running |
| 36 |
Use App::Prove or App::ForkProve. |
| 37 |
|
| 38 |
CPAN Uploading |
| 39 |
Use CPAN::Uploader. |
| 40 |
|
| 41 |
Changing the version number across many files |
| 42 |
Use Perl::Version. |
| 43 |
|
| 44 |
Integration with version control tools |
| 45 |
Just use `hg` or `svn` or `git` of whatever as you normally would. |
| 46 |
None of the files generated by Dist::Inkt should probably be checked |
| 47 |
into your repo. |
| 48 |
|
| 49 |
BUGS |
| 50 |
Please report any bugs to |
| 51 |
<http://rt.cpan.org/Dist/Display.html?Queue=Dist-Inkt>. |
| 52 |
|
| 53 |
SEE ALSO |
| 54 |
If you are not me, then you may well want one of these instead: |
| 55 |
|
| 56 |
* Dist::Zilla |
| 57 |
|
| 58 |
* Dist::Milla |
| 59 |
|
| 60 |
* Minilla |
| 61 |
|
| 62 |
Various extensions for Dist::Inkt: |
| 63 |
|
| 64 |
* Dist::Inkt::DOAP |
| 65 |
|
| 66 |
* Dist::Inkt::Profile::TOBYINK |
| 67 |
|
| 68 |
AUTHOR |
| 69 |
Toby Inkster <[email protected]>. |
| 70 |
|
| 71 |
COPYRIGHT AND LICENCE |
| 72 |
This software is copyright (c) 2013-2014 by Toby Inkster. |
| 73 |
|
| 74 |
This is free software; you can redistribute it and/or modify it under the |
| 75 |
same terms as the Perl 5 programming language system itself. |
| 76 |
|
| 77 |
DISCLAIMER OF WARRANTIES |
| 78 |
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED |
| 79 |
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF |
| 80 |
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. |
| 81 |
|