NAME

Module::Starter - a simple starter kit for any module

VERSION

Version 1.36

$Header: /home/cvs/module-starter/lib/Module/Starter.pm,v 1.9 2004/09/21 01:36:37 rjbs Exp $

SYNOPSIS

Nothing in here is meant for public consumption. Use module-starter from the command line.

module-starter --module=Foo::Bar,Foo::Bat \
    --author="Andy Lester" --email=andy@petdance.com

DESCRIPTION

This is the core module for Module::Starter. If you're not looking to extend or alter the behavior of this module, you probably want to look at module-starter instead.

Module::Starter is used to create a skeletal CPAN distribution, including basic builder scripts, tests, documentation, and module code. This is done through just one method, create_distro.

METHODS

Module::Starter->create_distro(%args)

create_distro is the only method you should need to use from outside this module; all the other methods are called internally by this one.

This method creates orchestrates all the work; it creates distribution and populates it with the all the requires files.

It takes a hash of params, as follows:

distro  => $distroname,      # distribution name (defaults to first module)
modules => [ module names ], # modules to create in distro
dir     => $dirname,         # directory in which to build distro
builder => 'Module::Build',  # defaults to ExtUtils::MakeMaker
                             # or specify more than one builder in an
                             # arrayref

license => $license,  # type of license; defaults to 'perl'
author  => $author,   # author's full name (required)
email   => $email,    # author's email address (required)

verbose => $verbose,  # bool: print progress messages; defaults to 0
force   => $force     # bool: overwrite existing files; defaults to 0

PLUGINS

Module::Starter itself doesn't actually do anything. It must load plugins that implement create_distro and other methods. This is done by the class's import routine, which accepts a list of plugins to be loaded, in order.

For more information, refer to Module::Starter::Plugin.

AUTHORS

Andy Lester, <petdance@cpan.org>

Ricardo Signes, <rjbs@cpan.org>

BUGS

Please report any bugs or feature requests to bug-module-starter@rt.cpan.org, or through the web interface at http://rt.cpan.org. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

COPYRIGHT

Copyright 2004 Andy Lester, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.