Johan Vromans > App-Module-Setup-0.06 > App::Module::Setup

Download:
App-Module-Setup-0.06.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.06   Source  

NAME ^

App::Module::Setup - a simple setup for a new module

SYNOPSIS ^

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

    module-setup --author="A.U. Thor" --email=a.u.thor@example.com Foo::Bar

DESCRIPTION ^

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

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

METHODS ^

App::Module::Setup->main( $options )

main 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 the distribution and populates it with the all the requires files.

It takes a reference to a hash of params, as follows:

    module       # module to create in distro
    version      # initial version
    author       # author's full name (taken from C<getpwuid> if not provided)
    email        # author's email address
    verbose      # bool: print progress messages; defaults to 0
    template     # template set to use
    postcmd      # array ref of commands to execute after creating
    install-templates # bool: just install the selected templates

AUTHOR ^

Johan Vromans, <jv at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-app-module-setup at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-Module-Setup. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc App::Module::Setup

You can also look for information at:

ACKNOWLEDGEMENTS ^

David Golden, for giving me the final incentive to write this module.

Sawyer X, for writing Module::Starter where I borrowed many ideas from.

COPYRIGHT & LICENSE ^

Copyright 2013 Johan Vromans, all rights reserved.

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

syntax highlighting: