module-template - Perl project scaffolding
This documentation refers to module-template version 0.01.
module-template Module::Name <MODULE::NAME> module-template Module::Name -c /path/to/config <MODULE::NAME> module-template Module::Name -t /path/to/templates <MODULE::NAME>
The only required argument is a valid module name. If you don't enter one on the command line, you will be prompted.
-c Path to configuration file -t Path to template directory
module-template creates a Perl project directory based off a template you define in $HOME/.module-template/templates. The 'templates' directory can contain Template Toolkit files, plain files, and directories. The directory structure will be recreated in your project directory. Template Toolkit files are processed as you would expect and plain files are copied to their respective location in your project directory.
You define any variables you want in $HOME/.module-template/config. Those variables will be available in your TT templates. Three template variables are defined inside module-template; module, today, and year. Some variables are set up for you in the config file. Feel free to change or remove these as you see fit.
module
today
year
The default license is Artistic 2.0. You can override that by creating your own LICENSE file and updating the license_type and license_body variables in your config file.
license_type
license_body
The first time you run module-template, a .module-template directory will be created for you in your $HOME directory.
Easy to use and quick to get running. This is all the documentation you need unless you don't know Template Toolkit.
module-template will not overwrite an existing .module-template directory in your home.
Edit $HOME/.module-template/config.
Define any variables you like and add them to your templates.
There is a template_toolkit section where you can add any TT2 configuration you like.
None.
App::Module::Template
None reported.
No bugs have been reported.
Please report any issues or feature requests to tscornpropst@gmail.com. Patches are welcome.
tscornpropst@gmail.com
Trevor S. Cornpropst tscornpropst@gmail.com
Copyright (c) 2014, Trevor S. Cornpropst tscornpropst@gmail.com. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
http://www.perlfoundation.org/artistic_license_2_0
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
To install App::Module::Template, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Module::Template
CPAN shell
perl -MCPAN -e shell install App::Module::Template
For more information on module installation, please visit the detailed CPAN module installation guide.