Adjust coding style from nmh to mmh
[mmh] / README
diff --git a/README b/README
index a4e21cd..81705d8 100644 (file)
--- a/README
+++ b/README
@@ -1,52 +1,78 @@
-#
-# README -- I love README files.
-#
-# $Id$
-#
+Meillo's Mail Handler (mmh)
+===========================
 
+Mmh is a modified version of the electronic mail handling system nmh.
+Nmh (new MH) itself was originally based on the package MH-6.8.3, and
+was intended to be a (mostly) compatible drop-in replacement for MH.
+In contrast, mmh is not inteded to be a drop-in replacement for nmh,
+rather mmh breaks compatibility to nmh in order to modernize and
+simplify it.
+
+Mmh is young and small; nmh is established and matured; MH is ancient.
+
+This distribution uses the term ``nmh'' to describe something common
+to nmh and mmh, in order to give credit. Where mmh differs much from
+nmh, the term ``mmh'' is used to avoid confusing the user.
+Unfortunately, the terms are not used fully consistent.
+
+
+Installing
+----------
+Please read the INSTALL file.
+
+
+Copying
+-------
+Mmh uses a BSD-style license, which should be in the top-level of the
+distribution in a file named COPYRIGHT.
+
+
+Users
+-----
+Start with reading the man page mmh-intro(7). It explains the first
+steps. For convenience in the shell, have a look at the files
+docs/COMPLETION-*. They give cookbook examples of how to set up mmh-
+specific tab completion in your shell.
+
+
+Developers
+----------
+Information of interest to mmh developers can be found in the
+README.developers file in the docs subdirectory of this distribution.
+Markus Schnalke's master's thesis explains the existence, shape, and
+focus of mmh. You should read it before working on mmh. If you're
+hacking on the code, you should subscribe to the nmh-workers mailing
+list. To do so, please visit the nmh-workers info page at
+<http://lists.nongnu.org/mailman/listinfo/nmh-workers>. Up to now,
+mmh has no separate mailing list.
+
+
+Bug reports
 -----------
-what is it?
------------
-nmh (new MH) is an electronic mail handling system.  It was
-originally based on the package MH-6.8.3, and is intended to be
-a (mostly) compatible drop-in replacement for MH.
-
-Although development of nmh is ongoing, it appears to be generally
-stable and is in current use.  But it is possible that we may
-break things as changes are made.
-
---------------
-installing nmh
---------------
-To install nmh, check the INSTALL and MACHINES files.  If you have
-previously used MH, check the file DIFFERENCES for a list of the
-differences between nmh and MH.
-
---------------------------------
-ftp and web sites, mailing lists
---------------------------------
-To find out about the mailing lists, ftp sites, and web page
-for nmh, check the FAQ included in this distribution.
+Please send bug reports and suggestions to either Markus Schnalke
+<meillo@marmaro.de> or to the <nmh-workers@nongnu.org> mailing list.
 
----------------
-nmh maintenance
----------------
-nmh is currently being developed and maintained by a loosely organized
-group of volunteers. Please send bug reports and suggestions to the
-nmh development mailing list at nmh-workers@mhost.com.
 
-----------------
-acknowledgments
-----------------
-The original MH system was developed by the RAND Corporation and the
-University of California.
+Acknowledgments
+---------------
+The MH system was originally developed in 1979 by the RAND
+Corporation. It was written primarily by Bruce S. Borden after ideas
+in a memo by R. Stockton Gaines and Norman Z. Shapiro. In 1982,
+the University of California, Irvine took up maintenance of the
+software, under the direction of Marshall T. Rose and John L. Romine.
 
 nmh was started by Richard Coleman (coleman@math.gatech.edu) after
 development on MH mostly stopped. He did the original autoconfiscation
-and most of the other work up until version 1.0.
+and most of the other work up until version 1.0. nmh is currently being
+developed and maintained by a loosely organized group of volunteers.
+
+
+For more information
+--------------------
+There is more information in the docs subdirectory. Please note that
+several documents are historic.
 
-nmh uses (v)snprintf code from the Apache web server, so we need to
-make the following acknowlegement:
+The mmh website is located at <http://marmaro.de/prog/mmh/>.
+Feel free to contact Markus Schnalke <meillo@marmaro.de>.
 
-This product includes software developed by the Apache Group
-for use in the Apache HTTP server project (http://www.apache.org/).
+(The nmh website is located at <http://nmh.nongnu.org/>.)