README
README.md
1# distribution Mail-Box-IMAP4
2
3 * My extended documentation: <http://perl.overmeer.net/CPAN/>
4 * Development via GitHub: <https://github.com/markov2/perl5-Mail-Box-IMAP4>
5 * Download from CPAN: <ftp://ftp.cpan.org/pub/CPAN/authors/id/M/MA/MARKOV/>
6 * Indexed from CPAN: <https://metacpan.org/release/Mail-Box-IMAP4>
7
8Until release 3.0, this module was an integral part of the Mail-Box
9distribution. This distribution implements a client connector to a
10IMAP4 server.
11
12## Development → Release
13
14Important to know, is that I use an extension on POD to write the manuals.
15The "raw" unprocessed version is visible on GitHub. It will run without
16problems, but does not contain manual-pages.
17
18Releases to CPAN are different: "raw" documentation gets removed from
19the code and translated into real POD and clean HTML. This reformatting
20is implemented with the OODoc distribution (A name I chose before OpenOffice
21existed, sorry for the confusion)
22
23Clone from github for the "raw" version. For instance, when you want
24to contribute a new feature.
25
26On github, you can find the processed version for each release. But the
27better source is CPAN; to get it installed simply run:
28
29```sh
30 cpan -i Mail::Box::IMAP4
31```
32
33## Contributing
34
35When you want to contribute to this module, you do not need to provide
36a perfect patch... actually: it is nearly impossible to create a patch
37which I will merge without modification. Usually, I need to adapt the
38style of code and documentation to my own strict rules.
39
40When you submit an extension, please contribute a set with
41
421. code
43
442. code documentation
45
463. regression tests in t/
47
48**Please note:**
49When you contribute in any way, you agree to transfer the copyrights to
50Mark Overmeer (you will get the honors in the code and/or ChangeLog).
51You also automatically agree that your contribution is released under
52the same license as this project: licensed as perl itself.
53
54## Copyright and License
55
56This project is free software; you can redistribute it and/or modify it
57under the same terms as Perl itself.
58See <http://dev.perl.org/licenses/>
59