Skip to content

Commit

Permalink
Try-Tiny-0.23
Browse files Browse the repository at this point in the history
  - fix syntax of example code (Rudolf Leermakers, PR#22)
  - 'perl' removed from prerequisite recommendations, to avoid tripping up
    CPAN clients (Graham Knop)
  - Sub::Util is used preferentially to Sub::Name in most cases (Graham Knop,
    PR#27)
  • Loading branch information
karenetheridge committed Dec 11, 2015
1 parent a2023f0 commit cb57845
Show file tree
Hide file tree
Showing 5 changed files with 772 additions and 1 deletion.
96 changes: 96 additions & 0 deletions CONTRIBUTING
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@

CONTRIBUTING

Thank you for considering contributing to this distribution. This file
contains instructions that will help you work with the source code.

PLEASE NOTE that if you have any questions or difficulties, you can reach the
maintainer(s) through the bug queue described later in this document
(preferred), or by emailing the releaser directly. You are not required to
follow any of the steps in this document to submit a patch or bug report;
these are just recommendations, intended to help you (and help us help you
faster).

The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
This means than many of the usual files you might expect are not in the
repository, but are generated at release time (e.g. Makefile.PL).

However, you can run tests directly using the 'prove' tool:

$ prove -l
$ prove -lv t/some_test_file.t
$ prove -lvr t/

In most cases, 'prove' is entirely sufficent for you to test any
patches you have.

You may need to satisfy some dependencies. The easiest way to satisfy
dependencies is to install the last release -- this is available at
https://metacpan.org/release/Try-Tiny

If you use cpanminus, you can do it without downloading the tarball first:

$ cpanm --reinstall --installdeps --with-recommends Try::Tiny

Dist::Zilla is a very powerful authoring tool, but requires a number of
author-specific plugins. If you would like to use it for contributing,
install it from CPAN, then run one of the following commands, depending on
your CPAN client:

$ cpan `dzil authordeps --missing`
or
$ dzil authordeps --missing | cpanm

You should then also install any additional requirements not needed by the
dzil build but may be needed by tests or other development:

$ cpan `dzil listdeps --author --missing`
or
$ dzil listdeps --author --missing | cpanm

Or, you can use the 'dzil stale' command to install all requirements at once:

$ cpan Dist::Zilla::App::Command::stale
$ cpan `dzil stale --all`
or
$ cpanm Dist::Zilla::App::Command::stale
$ dzil stale --all | cpanm

You can also do this via cpanm directly:

$ cpanm --reinstall --installdeps --with-develop --with-recommends Try::Tiny

Once installed, here are some dzil commands you might try:

$ dzil build
$ dzil test
$ dzil test --release
$ dzil xtest
$ dzil listdeps --json
$ dzil build --notgz

You can learn more about Dist::Zilla at http://dzil.org/.

The code for this distribution is hosted at GitHub. The repository is:
https://github.com/karenetheridge/Try-Tiny
You can submit code changes by forking the repository, pushing your code
changes to your clone, and then submitting a pull request. Detailed
instructions for doing that is available here:

https://help.github.com/articles/creating-a-pull-request

If you have found a bug, but do not have an accompanying patch to fix it, you
can submit an issue report here:
https://rt.cpan.org/Public/Dist/Display.html?Name=Try-Tiny
or via email: [email protected]
This is a good place to send your questions about the usage of this distribution.

If you send me a patch or pull request, your name and email address will be
included in the documentation as a contributor (using the attribution on the
commit or patch), unless you specifically request for it not to be. If you
wish to be listed under a different name or address, you should submit a pull
request to the .mailmap file to contain the correct mapping.


This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.009 from a
template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.109.
2 changes: 1 addition & 1 deletion Changes
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Revision history for Try-Tiny

{{$NEXT}}
0.23 2015-12-11 04:04:35Z
- fix syntax of example code (Rudolf Leermakers, PR#22)
- 'perl' removed from prerequisite recommendations, to avoid tripping up
CPAN clients (Graham Knop)
Expand Down
43 changes: 43 additions & 0 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
This is the Perl distribution Try-Tiny.

Installing Try-Tiny is straightforward.

## Installation with cpanm

If you have cpanm, you only need one line:

% cpanm Try::Tiny

If you are installing into a system-wide directory, you may need to pass the
"-S" flag to cpanm, which uses sudo to install the module:

% cpanm -S Try::Tiny

## Installing with the CPAN shell

Alternatively, if your CPAN shell is set up, you should just be able to do:

% cpan Try::Tiny

## Manual installation

As a last resort, you can manually install it. Download the tarball, untar it,
then build it:

% perl Makefile.PL
% make && make test

Then install it:

% make install

If you are installing into a system-wide directory, you may need to run:

% sudo make install

## Documentation

Try-Tiny documentation is available as POD.
You can run perldoc from a shell to read the documentation:

% perldoc Try::Tiny
32 changes: 32 additions & 0 deletions LICENCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
This software is Copyright (c) 2009 by יובל קוג'מן (Yuval Kogman).

This is free software, licensed under:

The MIT (X11) License

The MIT License

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to
whom the Software is furnished to do so, subject to the
following conditions:

The above copyright notice and this permission notice shall
be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
Loading

0 comments on commit cb57845

Please sign in to comment.