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