About [%name%]
======[%char='=';char.repeat(name.length)%]

This repository contains the source code for the Perl 5 module distribution:

  [%name%] — "[%abstract%]"

    by [%author.0.name%]

  Copyright [%copyright%]. [%author.0.name%].

License
-------

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

See http://www.perl.com/perl/misc/Artistic.html

Installation
------------

You can install the latest release of [%name%] with this command:

  cpanm [%name.replace('-','::')%]

If you don't have `cpanm` yet, installation is simple. See:

  https://metacpan.org/pod/App::cpanminus#INSTALLATION

Or get the release information directly from:

  https://metacpan.org/release/[%name%]

Open Source
-----------

The code for [%name%] is hosted at GitHub. The URL is:

  [%devel.git%]

This project uses the Zilla-Dist framework for development and release
automation. You install it with:

  cpanm -n Zilla::Dist   # -n means "no test" which can save a lot of time

Once installed, run `zild make` to get a list of all the things you can do.
See https://metacpan.org/pod/distribution/Zilla-Dist/lib/Zilla/Dist.pod for
more information.

NOTE: If you just want to run the tests without installing Zilla::Dist, use:

  prove -lv test/

Repository Layout
-----------------

This repoository contains the following top level files and directories:

[%IF layout.About-%]
  About       - This file describing the repository. (generated)
[%END-%]
[%IF layout.Changes-%]
  Changes     - Change log file in YAML.
[%END-%]
[%IF layout.item('gitignore')-%]
  .gitignore  - Git's ignore file.
[%END-%]
[%IF layout.Meta-%]
  Meta        - All metadata for the project.
[%END-%]
[%IF layout.ReadMe_pod-%]
  ReadMe.pod  - Top level ReadMe file for GitHub. (generated)
[%END-%]
[%IF layout.item('travis_yml')-%]
  .travis.yml - Travis CI test control file. (generated)
[%END-%]

[%IF layout.bin-%]
  bin/        - Directory of installable scripts.
[%END-%]
[%IF layout.doc-%]
  doc/        - Documentation directory.
[%END-%]
[%IF layout.eg-%]
  eg/         - Example files.
[%END-%]
[%IF layout.ext-%]
  ext/        - External dependency repos.
[%END-%]
[%IF layout.item('git')-%]
  .git/       - Git repository data.
[%END-%]
[%IF layout.lib-%]
  lib/        - All the source code libraries (modules).
[%END-%]
[%IF layout.note-%]
  note/       - Random note files. To-Do lists, specs, etc.
[%END-%]
[%IF layout.pkg-%]
  pkg/        - Packaging tools and data.
[%END-%]
[%IF layout.share-%]
  share/      - Shared files for the release package.
[%END-%]

Resources
---------

[%IF homepage != 'https://metacpan.org/release/' _ name-%]
  Home Page   - [%homepage%]
[%END-%]
  Source      - [%devel.git%]
  Release     - https://metacpan.org/release/[%name%]
  Bugs        - [%devel.bug%]
[%IF devel.irc-%]
  Pulls       - [%devel.git _ '/pulls'%]
  IRC         - [%devel.irc%]
[%END-%]
[%IF devel.eml-%]
  Email List  - [%devel.eml%]
[%END-%]

Contributing
------------

If you would like to contribute to this project, please read:

  https://metacpan.org/pod/Zilla::Dist::Contributing

for up-to-date instructions.





# This file generated by Zilla-Dist-[%zilla_dist.version%]
