README.pod
1=pod
2
3=encoding utf8
4
5=for HTML <a href="https://github.com/briandfoy/test-file/actions?query=workflow%3Amacos"><img src="https://github.com/briandfoy/test-file/workflows/macos/badge.svg"></a>
6
7=for HTML <a href="https://github.com/briandfoy/test-file/actions?query=workflow%3Aubuntu"><img src="https://github.com/briandfoy/test-file/workflows/ubuntu/badge.svg"></a>
8
9=for HTML <a href="https://github.com/briandfoy/test-file/actions?query=workflow%3Awindows"><img src="https://github.com/briandfoy/test-file/workflows/windows/badge.svg"></a>
10
11=for HTML <a href='https://ci.appveyor.com/project/briandfoy/test-file'><img src='https://ci.appveyor.com/api/projects/status/dbgen56rlgilgma5'></a>
12
13=for HTML <a href='https://coveralls.io/github/briandfoy/test-file?branch=master'><img src='https://coveralls.io/repos/github/briandfoy/test-file/badge.svg?branch=master' alt='Coverage Status' /></a>
14
15=for HTML <a href="https://github.com/briandfoy/test-file/blob/master/LICENSE"><img src="https://img.shields.io/cpan/l/Test-File.svg" /></a>
16
17=for HTML <a href="https://metacpan.org/pod/Test::File"><img src="https://img.shields.io/cpan/v/Test-File.svg" /></A>
18
19=head1 The Test::File module
20
21This is the I<README> for the L<Test::File> Perl module, which provides
22convenience test functions to check file attributes and data in a
23L<Test::More|https://metacpan.org/pod/Test::More> fashion.
24
25You're probably looking at this because you don't know where else to
26find what you're looking for. Read this once and you might never have
27to read one again for any Perl module.
28
29=head2 Documentation
30
31To read about L<Test::File>, look at the embedded documentation
32in the module itself. Inside the distribution, you can format it
33with L<perldoc|https://perldoc.perl.orgperldoc.html>:
34
35 % perldoc lib/Test/File.pm
36
37If you have already installed the module, you can specify the module
38name instead of the file location:
39
40 % perldoc Test::File
41
42You can read the documentation and inspect the meta data at
43L<MetaCPAN|https://metacpan.org/pod/Test::File>.
44
45The standard module documentation has example uses in the SYNOPSIS
46section, but you can also look in the I<examples/> directory (if it's
47there), or look at the test files in I<t/>.
48
49=head2 Installation
50
51You can install this module with a CPAN client, which will resolve
52and install the dependencies:
53
54 % cpan Test::File
55 % cpanm Test::File
56
57You can also install directly from the distribution directory, which
58will also install the dependencies:
59
60 % cpan .
61 % cpanm .
62
63You could install just this module manually:
64
65 % perl Makefile.PL
66 % make
67 % make test
68 % make install
69
70You probably don't want to do that unless you're fiddling with the
71module and only want to run the tests without installing anything.
72
73=head2 Source location
74
75The meta data, such as the source repository and bug tracker, is in
76I<Makefile.PL> or the I<META.*> files it creates. You can find that on
77those CPAN web interfaces, but you can also look at files directly in
78the source repository:
79
80=over 4
81
82=item * L<https://github.com/briandfoy/test-file>
83
84=back
85
86If you find a problem, file a ticket in the L<issue
87tracker|https://github.com/briandfoy/test-file/issues>:
88
89=over 4
90
91=item * L<https://github.com/briandfoy/test-file/issues>
92
93=back
94
95=head2 Getting help
96
97Although I'm happy to hear from module users in private email,
98that's the best way for me to forget to do something.
99
100Besides the issue trackers, you can find help at
101L<Perlmonks|http://www.perlmonks.org> or
102L<Stackoverflow|http://www.stackoverflow.com>, both of which have many
103competent Perlers who can answer your question, almost in real time.
104They might not know the particulars of this module, but they can help
105you diagnose your problem.
106
107You might like to read L<brian's Guide to Solving Any Perl
108Problem|http://archive.oreilly.com/pub/a/perl/excerpts/9780596527242/brians-guide.html>.
109
110=head2 Copyright and License
111
112You should have received a I<LICENSE> file, but the license is also noted
113in the module files. About the only thing you can't do is pretend that
114you wrote code that you didn't.
115
116=head2 Good luck!
117
118Enjoy,
119
120brian d foy, bdfoy@cpan.org
121
122=cut
123
