Codebase list libio-interactive-perl / d66c028
Add badges to README brian d foy 6 years ago
1 changed file(s) with 23 addition(s) and 13 deletion(s). Raw diff Collapse all Expand all
+23
-13
README.pod less more
11
22 =encoding utf8
33
4 =for HTML <a href="https://travis-ci.org/briandfoy/io-interactive"><img src="https://travis-ci.org/briandfoy/io-interactive.svg?branch=master" /></a>
5
6 =for HTML <a href='https://ci.appveyor.com/project/briandfoy/io-interactive'><img src='https://ci.appveyor.com/api/projects/status/nxocrwut3tcni3ei' /></a>
7
8 =for HTML <a href='https://coveralls.io/github/briandfoy/io-interactive?branch=master'><img src='https://coveralls.io/repos/github/briandfoy/io-interactive/badge.svg?branch=master' alt='Coverage Status' /></a>
9
10 =for HTML <a href="https://github.com/briandfoy/io-interactive/blob/master/LICENSE"><img src="https://img.shields.io/cpan/l/IO-Interactive.svg" /></a>
11
12 =for HTML <a href="http://www.metacpan.org/module/IO::Interactive"><img src="https://img.shields.io/cpan/v/IO-Interactive.svg" /></A>
13
414 =head1 The IO::Interactive module
515
6 This is the I<README> for the L<IO::Interactive> Perl module. You're probably
16 This is the I<README> for the L<IO::Interactive> Perl module. You're probably
717 looking at this because you don't know where else to find what you're
8 looking for. Read this once and you might never have to read one again
18 looking for. Read this once and you might never have to read one again
919 for any Perl module.
1020
1121 =head2 Documentation
1222
13 To read about L<IO::Interactive>, look at the embedded documentation
14 in the module itself. Inside the distribution, you can format it
23 To read about L<IO::Interactive>, look at the embedded documentation
24 in the module itself. Inside the distribution, you can format it
1525 with L<perldoc|http://perldoc.perl.org/perldoc.html>:
1626
1727 % perldoc lib/IO/Interactive.pm
2131
2232 % perldoc IO::Interactive
2333
24 You can read the documentation and inspect the meta data on one of the
25 CPAN web interfaces, such as L<CPAN Search|http://search.cpan.org/dist/IO-Interactive> or
34 You can read the documentation and inspect the meta data on one of the
35 CPAN web interfaces, such as L<CPAN Search|http://search.cpan.org/dist/IO-Interactive> or
2636 L<MetaCPAN|http://www.metacpan.org/module/IO::Interactive>:
2737
2838 =over 4
5868 % make test
5969 % make install
6070
61 You probably don't want to do that unless you're fiddling with the
71 You probably don't want to do that unless you're fiddling with the
6272 module and only want to run the tests without installing anything.
6373
6474 =head2 Source location
65
75
6676 The meta data, such as the source repository and bug tracker, is in
6777 I<Makefile.PL> or the I<META.*> files it creates. You can find that on
6878 those CPAN web interfaces, but you can also look at files directly in
7484
7585 =back
7686
77 If you find a problem, file a ticket in the L<issue
87 If you find a problem, file a ticket in the L<issue
7888 tracker|https://github.com/briandfoy/io-interactive/issues>:
7989
8090 =over 4
93103 L<Stackoverflow|http://www.stackoverflow.com>, both of which have many
94104 competent Perlers who can answer your question, almost in real time.
95105 They might not know the particulars of this module, but they can help
96 you diagnose your problem.
106 you diagnose your problem.
97107
98 You might like to read L<brian's Guide to Solving Any Perl
108 You might like to read L<brian's Guide to Solving Any Perl
99109 Problem|http://archive.oreilly.com/pub/a/perl/excerpts/9780596527242/brians-guide.html>.
100110
101111 =head2 Copyright and License
102112
103113 You should have received a I<LICENSE> file, but the license is also noted
104114 in the module files. About the only thing you can't do is pretend that
105 you wrote code that you didn't.
115 you wrote code that you didn't.
106116
107117 =head2 Good luck!
108118
109 Enjoy,
119 Enjoy,
110120
111121 brian d foy, bdfoy@cpan.org
112122