1# distribution Log-Report
2
3  * My extended documentation: <http://perl.overmeer.net/CPAN/>
4  * Development via GitHub: <https://github.com/markov2/perl5-Log-Report>
5  * Download from CPAN: <ftp://ftp.cpan.org/pub/CPAN/authors/id/M/MA/MARKOV/>
6  * Indexed from CPAN: <https://metacpan.org/release/Log-Report>
7
8Get messages to users and logs.  Log::Report combines three tasks
9which are closely related in one:
10
11  . logging (like Log::Log4Perl and syslog), and
12  . exceptions (like error and info), with
13  . translations (like gettext and Locale::TextDomain)
14
15You **do not need** to use this module for all three reasons: pick what
16you need now, maybe extend the usage later.
17
18To enable translations, you need to install "Log::Report::Lexicon"
19
20## Development &rarr; Release
21
22Important to know, is that I use an extension on POD to write the manuals.
23The "raw" unprocessed version is visible on GitHub.  It will run without
24problems, but does not contain manual-pages.
25
26Releases to CPAN are different: "raw" documentation gets removed from
27the code and translated into real POD and clean HTML.  This reformatting
28is implemented with the OODoc distribution (A name I chose before OpenOffice
29existed, sorry for the confusion)
30
31Clone from github for the "raw" version.  For instance, when you want
32to contribute a new feature.
33
34On github, you can find the processed version for each release.  But the
35better source is CPAN; to get it installed simply run:
36
37```sh
38   cpan -i Log::Report
39```
40
41## Contributing
42
43When you want to contribute to this module, you do not need to provide
44a perfect patch... actually: it is nearly impossible to create a patch
45which I will merge without modification.  Usually, I need to adapt the
46style of code and documentation to my own strict rules.
47
48When you submit an extension, please contribute a set with
49
501. code
51
522. code documentation
53
543. regression tests in t/
55
56**Please note:**
57When you contribute in any way, you agree to transfer the copyrights to
58Mark Overmeer (you will get the honors in the code and/or ChangeLog).
59You also automatically agree that your contribution is released under
60the same license as this project: licensed as perl itself.
61
62## Copyright and License
63
64This project is free software; you can redistribute it and/or modify it
65under the same terms as Perl itself.
66See <http://dev.perl.org/licenses/>
67