From: Nigel Metheringham <nigel@exim.org>
Date: Fri, 18 Nov 2011 13:36:14 +0000 (+0000)
Subject: Rough readme mainly for benefit of github
X-Git-Tag: exim-4_80_RC1~101
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=1e0dc8a5514174a10f4a21e88600c84cfd40ee18;p=exim.git

Rough readme mainly for benefit of github

Pod translator is lousing up - may move to a different
format for the future.  [issues are with L<> links]
---

diff --git a/Readme.pod b/Readme.pod
new file mode 100644
index 000000000..d49fc9651
--- /dev/null
+++ b/Readme.pod
@@ -0,0 +1,66 @@
+=head1 Exim Development Repository
+
+This is the Exim (Mail Transport Agent) Development Repository. Please
+read the following information if you wish to use or contribute to the
+Exim development process - this is to prevent your or our time being
+unnecessarily wasted.
+
+If you just want to use, build or get information on Exim then have a
+look at the pointers further down this file at L<General Exim Information>.
+
+=head2 General Development Information
+
+The general Exim development process and resources are documented in
+the wiki page at L<http://wiki.exim.org/EximDevelopment> - although
+the wiki is likely to be moved and rehashed in the near future.
+
+The sections below this duplicate much of the information form the
+wiki document.
+
+=head2 Development Repositories
+
+Exim development is kept within a  git (L<http://git-scm.com/>)
+repository. The master repository is at L<git://git.exim.org/exim.git>
+with a web interface giving change and source visibility at
+L<http://git.exim.org/exim.git>
+
+There is a secondary repository on github at
+L<https://github.com/Exim/exim> managed by the Exim Organisation
+L<https://github.com/Exim> - however this may currently fall out of
+synchronisation with the main one. We intend to manage this better in
+the future, but it is currently early days for our github repo.
+
+=head2 Bug Tracking
+
+Currently this is all done using Bugzilla at L<http://bugs.exim.org/>
+- please do not use github issue tracking.
+
+=head2 Mailing List
+
+Development issues are normally discussed on the exim-dev Mailing list
+- see L<http://www.exim.org/maillist.html>
+
+=head2 Exim Release Process
+
+Some documentation on the realse process can be found at
+L<http://wiki.exim.org/EximRelease>.
+
+=head2 General Exim Information
+
+The best place to get general information is on the website at
+L<http://www.exim.org/>.
+
+You can find Download locations L<http://www.exim.org/mirrors.html>,
+Mailing list info L<http://www.exim.org/maillist.html> and Full
+Documentation L<http://www.exim.org/docs.html> on that website.
+
+If you are using a Linux or other freely available Unix like operating
+system it is very likely that your system will have Exim packaged for
+it already. In this case it is probably prudent to use these packages
+unless you have specialised requirements.
+
+In any case you can always ask on the 
+Exim Users mailing list L<https://lists.exim.org/mailman/listinfo/exim-users> 
+for further information.
+
+[End]
\ No newline at end of file