Changeset 27:b1d527287347 in mailjam for README

Timestamp:

May 23, 2012, 6:32:54 PM (13 years ago)

Author:

Borja Lopez <borja@…>

Branch:

default

Phase:

public

Message:

Added more information to the README file

Updated the architecture scheme so it fits the renaming of the project
to mailjam

Fixed the search path for configuration files. Now it searches on /etc
first, /usr/local/etc then.

Added more docs regarding the installation, configuration and running
of each component

File:

• README (modified) (2 diffs)

README

@@ -14 +14 @@
 with sendmail [2]_ and postfix [3]_ but it should work with other MTA software)
 
+Overview
+--------
+
+.. image:: docs/src/mailjam_architecture.png
+   :alt: Scheme of the architecture behind Mailjam
+
+Mailjam has been designed following a **multi-component structure**. There is 
+**a daemon** that manage the mailing lists and members information in a storage
+backend and there are **different kinds of clients** (currently, three of them)
+that **interact with the daemon using a XMLRPC link**.
+
+More information here: http://readthedocs.org/docs/mailjam/en/latest/overview.html
 
 Install
@@ -21 +33 @@
 documentation inside the docs/ subdirectory.
 
+You can read the installation instructions here:
+http://readthedocs.org/docs/mailjam/en/latest/install.html
 
-Learn more
-----------
+Documentation
+-------------
 
-If you would like to learn more about Mailjam (its internals, how it works,
-etc) take a look at the official documentation inside the docs/ subdirectory.
-
-You can read the docs online too (thnx to readthedocs.org [4]_):
+The official documentation is available in the docs/ subdirectory, and
+you can read the docs online too (thnx to readthedocs.org [4]_):
 
 http://mailjam.readthedocs.org