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