README.pod
1=pod
2
3=encoding utf8
4
5=head1 The SVN::Hooks module
6
7L<SVN hooks|http://svnbook.red-bean.com/nightly/en/svn.reposadmin.create.html> are
8programs you install in SVN repositories in order to augment SVN's
9functionality.
10
11The SVN::Hooks module is a framework to make it easier to implement SVN
12hooks.
13
14=head2 Documentation
15
16To read about L<SVN::Hooks>, look at the embedded documentation in the
17module itself. Inside the distribution, you can format it with
18L<perldoc|http://perldoc.perl.org/perldoc.html>:
19
20 $ perldoc lib/SVN/Hooks.pm
21
22If you have already installed the module, you can specify the module name
23instead of the file location:
24
25 $ perldoc SVN::Hooks
26
27You can read the documentation and inspect the meta data on one of the CPAN
28web interfaces, such as L<CPAN Search|http://search.cpan.org/dist/SVN-Hooks>
29or L<MetaCPAN|http://metacpan.org/release/SVN::Hooks>:
30
31=over 4
32
33=item * L<http://search.cpan.org/dist/SVN-Hooks>
34
35=item * L<http://metacpan.org/release/SVN::Hooks>
36
37=back
38
39The standard module documentation has example uses in the SYNOPSIS section,
40but you can also look in the I<examples/> directory (if it's there), or look
41at the test files in I<t/>.
42
43=head2 Installation
44
45You can install this module with a CPAN client, which will resolve
46and install the dependencies:
47
48 $ cpan SVN::Hooks
49 $ cpanm SVN::Hooks
50
51SVN::Hooks is packaged with L<Dist::Zilla>, so that you can't install it
52directly from the repository.
53
54=head2 Source location
55
56The meta data, such as the source repository and bug tracker, is in
57I<Makefile.PL> or the I<META.*> files it creates. You can find that on
58those CPAN web interfaces, but you can also look at files directly in
59the source repository:
60
61=over 4
62
63=item * L<https://github.com/gnustavo/SVN-Hooks>
64
65=back
66
67If you find a problem, file a ticket in the L<issue
68tracker|https://github.com/gnustavo/SVN-Hooks/issues>:
69
70=over 4
71
72=item * L<https://github.com/gnustavo/SVN-Hooks/issues>
73
74=back
75
76=head2 Getting help
77
78Although I'm happy to hear from module users in private email, that's the
79best way for me to forget to do something.
80
81Besides the issue trackers, you can find help at
82L<Perlmonks|http://www.perlmonks.org> or
83L<Stackoverflow|http://www.stackoverflow.com>, both of which have many
84competent Perlers who can answer your question, almost in real time. They
85might not know the particulars of this module, but they can help you
86diagnose your problem.
87
88You might like to read L<brian's Guide to Solving Any Perl
89Problem|http://archive.oreilly.com/pub/a/perl/excerpts/9780596527242/brians-guide.html>.
90
91=head2 Copyright and License
92
93You should have received a I<LICENSE> file, but the license is also noted in
94the module files. About the only thing you can't do is pretend that you
95wrote code that you didn't.
96
97=head2 Good luck!
98
99Enjoy,
100
101Gustavo Chaves, gnustavo@cpan.org
102
103=cut
104