view release on metacpan or  search on metacpan

share/templates/readme.tmpl  view on Meta::CPAN

  If a test fails, you can run a single test with verbose output via:

      tests/runtests -o <name-of-test>

  Do this instead of running the test program directly since it will
  ensure that necessary environment variables are set up.
[% END %][% IF test.suffix %]
[% indent(to_text(test.suffix), 2) %]
[% END %][% END %][% IF test.lancaster %]
  To enable tests that don't detect functionality problems but are used to
  sanity-check the release, set the environment variable RELEASE_TESTING
  to a true value.  To enable tests that may be sensitive to the local
  environment or that produce a lot of false positives without uncovering
  many problems, set the environment variable AUTHOR_TESTING to a true
  value.
[% END %][% END %]
[% FOREACH section IN sections %][% section.title FILTER upper %]

[% indent(to_text(section.body), 2) %]

[% END %]SUPPORT[% IF unmaintained %]

  This package is not currently maintained and will not get further
  releases or bug fixes.  I do not recommend using it unless you're
  willing to take over maintenance.

  The [% name %] web page at:

      [% support.web %]

  has the last released version, its documentation, and pointers to any
  additional resources.[% IF support.extra %]

[% indent(to_text(support.extra), 2) %]
[% END %][% ELSE %]

  The [% name %] web page at:

      [% support.web %]

  will always have the current version of this package, the current
  documentation, and pointers to any additional resources.
[% IF support.listname %]
  New [% name %] releases are announced on the [% support.listname %]
  mailing list.  To subscribe or see the list archives, go to:

      [% support.listurl %]
[% END %][% IF support.extra %]
[% indent(to_text(support.extra), 2) %]
[% END %]
[% IF support.github %]
  For bug tracking, use the issue tracker on GitHub:

      https://github.com/[% support.github %]/issues

[% ELSE %]

  I welcome bug reports and patches for this package at
  [% support.email %].[% END %]  Please be aware that I tend to be
  extremely busy and work projects often take priority.  I'll save your
  report and get to it as soon as I can, but it may take me a couple of
  months.[% END %]

SOURCE REPOSITORY

  [% name %] [% IF unmaintained %]was[% ELSE %]is[% END %] maintained using [% vcs.type %].  You can access the current source [% IF vcs.github %]on GitHub at:

      https://github.com/[% vcs.github %]

  or [% END %]by cloning the repository at:

      [% vcs.url %]

  or view the repository via the web at:

      [% vcs.browse %]
[% IF !unmaintained %][% IF vcs.github %]
  The eyrie.org repository is the canonical one, maintained by the author,
  but using GitHub is probably more convenient for most purposes.  Pull
  requests are gratefully reviewed and normally accepted.
[% ELSIF vcs.type == 'Git' %]
  When contributing modifications, patches (possibly generated by
  git-format-patch) are preferred to Git pull requests.
[% END %][% END %]
LICENSE

  The [% name %] package as a whole is covered by the following copyright
  statement and license:

[% copyright(4) %]

[% indent(license.text, 4) %]
[% IF license.notices %]
[% indent(to_text(license.notices), 4) %]
[% END %]
  Some files in this distribution are individually released under
  different licenses, all of which are compatible with the above general
  package license but which may require preservation of additional
  notices.  All required notices, and detailed information about the
  licensing of each file, are recorded in the LICENSE file.

  Files covered by a license with an assigned SPDX License Identifier
  include SPDX-License-Identifier tags to enable automated processing of
  license information.  See https://spdx.org/licenses/ for more
  information.

  For any copyright range specified by files in this package as YYYY-ZZZZ,
  the range specifies every single year in that closed interval.