File: README.pod

package info (click to toggle)
libtie-cycle-perl 1.225-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 144 kB
  • sloc: perl: 51; makefile: 2
file content (129 lines) | stat: -rw-r--r-- 4,006 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
=pod

=encoding utf8

=for HTML <a href="https://travis-ci.org/briandfoy/tie-cycle"><img src="https://travis-ci.org/briandfoy/tie-cycle.svg?branch=master" /></a>

=for HTML <a href='https://ci.appveyor.com/project/briandfoy/tie-cycle'><img src='https://ci.appveyor.com/api/projects/status/ghir4biemgd8p717' /></a>

=for HTML <a href='https://coveralls.io/github/briandfoy/tie-cycle?branch=master'><img src='https://coveralls.io/repos/github/briandfoy/tie-cycle/badge.svg?branch=master' alt='Coverage Status' /></a>

=for HTML <a href="https://github.com/briandfoy/tie-cycle/blob/master/LICENSE"><img src="https://img.shields.io/cpan/l/Tie-Cycle.svg" /></a>

=for HTML <a href="http://www.metacpan.org/module/Tie::Cycle"><img src="https://img.shields.io/cpan/v/Tie-Cycle.svg" /></A>

=head1 The Tie::Cycle module

This is the I<README> for the L<Tie::Cycle> Perl module. It allows
you to create an array that continually cycles through its elements
no matter what index you use. It's mostly a demonstration of the
C<tie> mechanism.

You're probably looking at this because you don't know where else to
find what you're looking for. Read this once and you might never have
to read one again for any Perl module.

=head2 Documentation

To read about L<Tie::Cycle>, look at the embedded documentation
in the module itself. Inside the distribution, you can format it
with L<perldoc|http://perldoc.perl.org/perldoc.html>:

	% perldoc lib/Tie/Cycle.pm

If you have already installed the module, you can specify the module
name instead of the file location:

	% perldoc Tie::Cycle

You can read the documentation and inspect the meta data on one of the
CPAN web interfaces, such as L<CPAN
Search|http://search.cpan.org/dist/Tie-Cycle> or
L<MetaCPAN|http://www.metacpan.org/module/Tie::Cycle>:

=over 4

=item *	L<http://search.cpan.org/dist/Tie-Cycle>

=item *	L<http://www.metacpan.org/module/Tie::Cycle>

=back

The standard module documentation has example uses in the SYNOPSIS
section, but you can also look in the I<examples/> directory (if it's
there), or look at the test files in I<t/>.

=head2 Installation

You can install this module with a CPAN client, which will resolve
and install the dependencies:

	% cpan Tie::Cycle
	% cpanm Tie::Cycle

You can also install directly from the distribution directory, which
will also install the dependencies:

	% cpan .
	% cpanm .

You could install just this module manually:

	% perl Makefile.PL
	% make
	% make test
	% make install

You probably don't want to do that unless you're fiddling with the
module and only want to run the tests without installing anything.

=head2 Source location

The meta data, such as the source repository and bug tracker, is in
I<Makefile.PL> or the I<META.*> files it creates. You can find that on
those CPAN web interfaces, but you can also look at files directly in
the source repository:

=over 4

=item *	L<https://github.com/briandfoy/tie-cycle>

=back

If you find a problem, file a ticket in the L<issue
tracker|https://github.com/briandfoy/tie-cycle/issues>:

=over 4

=item *	L<https://github.com/briandfoy/tie-cycle/issues>

=back

=head2 Getting help

Although I'm happy to hear from module users in private email,
that's the best way for me to forget to do something.

Besides the issue trackers, you can find help at
L<Perlmonks|http://www.perlmonks.org> or
L<Stackoverflow|http://www.stackoverflow.com>, both of which have many
competent Perlers who can answer your question, almost in real time.
They might not know the particulars of this module, but they can help
you diagnose your problem.

You might like to read L<brian's Guide to Solving Any Perl
Problem|http://archive.oreilly.com/pub/a/perl/excerpts/9780596527242/brians-guide.html>.

=head2 Copyright and License

You should have received a I<LICENSE> file, but the license is also noted
in the module files. About the only thing you can't do is pretend that
you wrote code that you didn't.

=head2 Good luck!

Enjoy,

brian d foy, bdfoy@cpan.org

=cut