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