Choose Your Own Tutorial
Building a Dist from Scratch
Starting a distribution with Dist::Zilla is easy. It provides a system for "minting" new distributions, much like `h2xs`, Module::Starter, or other similar tools. Unlike those, it is extremely customizable and can be made to do much more than just build a bunch of files for you to edit.
For the tasks below, you'll want to:
The rest of this document assumes that you haven't made a custom minting profile, meaning that you haven't got anything in ~/.dzil/profiles. If you do, and the behavior you see isn't what's described below, you might want to move that directory out of the way, or read more about how minting profiles work.
$ dzil new Your::Library
[DZ] making target dir ./Your-Library
[DZ] writing files to /Users/rjbs/tmp/Your-Library
[DZ] dist minted in ./Your-Library
If you haven't set up any special minting configuration, you'll have two files.
name = Your-Library
There isn't a lot of other boilerplate, because the default minter assumes that you're going to go whole hog and use lots of plugins to build everything else you might need. It doesn't add those plugins to your dist.ini for you, though. The only plugins it does add are the ones in the Basic bundle, so that the other
dzil commands work. You'll have to choose the other plugins yourself.
It's crucial that you understand what's in that "@Basic" bundle. That is almost the entire configuration that will be used to build your distribution. If you add more plugins that conflict with the ones in the basic bundle, but you had no idea what was in "@Basic", you will be confused.
Write some code and some tests
This bit is just like it would be with anything else: do the hard work that will make releasing the dist worthwhile. Dist::Zilla, sadly, will not write your code or your code's tests for you.
You'll also want to write documentation, of course, but Dist::Zilla can help make that less painful. Choose an appropriate set of plugins, test, and release!
If you'd like to learn about declaring prerequisites, turn to page 5
If you'd like to learn how Dist::Zilla helps you write docs, turn to page 7
If you'd like to learn how to test your distribution, turn to page 8
If you'd like to learn how to release your distribution to the CPAN, turn to page 9
If you'd like to learn how to customize the minting process, turn to page 16
If you'd like to learn about plugins and Dist::Zilla's build phases, turn to page 14