exigrep: add POD and -h, -m
[exim.git] / Readme.pod
1 =head1 Exim Development Repository
2
3 This is the Exim (Mail Transport Agent) Development Repository. Please
4 read the following information if you wish to use or contribute to the
5 Exim development process - this is to prevent your or our time being
6 unnecessarily wasted.
7
8 If you just want to use, build or get information on Exim then have a
9 look at the pointers further down this file at L<General Exim Information>.
10
11 =head2 General Development Information
12
13 The general Exim development process and resources are documented in
14 the wiki page at L<http://wiki.exim.org/EximDevelopment> - although
15 the wiki is likely to be moved and rehashed in the near future.
16
17 The sections below this duplicate much of the information form the
18 wiki document.
19
20 =head2 Development Repositories
21
22 Exim development is kept within a  git (L<http://git-scm.com/>)
23 repository. The master repository is at L<git://git.exim.org/exim.git>
24 with a web interface giving change and source visibility at
25 L<http://git.exim.org/exim.git>
26
27 There is a secondary repository on github at
28 L<https://github.com/Exim/exim> managed by the Exim Organisation
29 L<https://github.com/Exim> - however this may currently fall out of
30 synchronisation with the main one. We intend to manage this better in
31 the future, but it is currently early days for our github repo.
32
33 =head2 Bug Tracking
34
35 Currently this is all done using Bugzilla at L<http://bugs.exim.org/>
36 - please do not use github issue tracking.
37
38 =head2 Mailing List
39
40 Development issues are normally discussed on the exim-dev mailing list
41 - see L<http://www.exim.org/maillist.html>
42
43 =head2 Exim Release Process
44
45 Some documentation on the release process can be found at
46 L<http://wiki.exim.org/EximRelease>.
47
48 =head2 General Exim Information
49
50 The best place to get general information is on the website at
51 L<http://www.exim.org/>.
52
53 You can find Download locations L<http://www.exim.org/mirrors.html>,
54 Mailing list info L<http://www.exim.org/maillist.html> and Full
55 Documentation L<http://www.exim.org/docs.html> on that website.
56
57 If you are using a Linux or other freely available Unix like operating
58 system it is very likely that your system will have Exim packaged for
59 it already. In this case it is probably prudent to use these packages
60 unless you have specialised requirements.
61
62 In any case you can always ask on the 
63 Exim Users mailing list L<https://lists.exim.org/mailman/listinfo/exim-users> 
64 for further information.
65
66 [End]