Included the relevant parts of docs/README.about into README.
authormarkus schnalke <meillo@marmaro.de>
Fri, 7 Dec 2012 22:00:57 +0000 (23:00 +0100)
committermarkus schnalke <meillo@marmaro.de>
Fri, 7 Dec 2012 22:00:57 +0000 (23:00 +0100)
Also updated the information to mmh.

README
docs/Makefile.in
docs/README.about [deleted file]

diff --git a/README b/README
index b61ba4c..81705d8 100644 (file)
--- a/README
+++ b/README
@@ -1,32 +1,78 @@
+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
 -------
-nmh uses a BSD-style license, which should be in the top-level of the
+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 nmh developers can be found in the
+Information of interest to mmh developers can be found in the
 README.developers file in the docs subdirectory of this distribution.
-If you're hacking on the code, you should also definitely 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>.
-If you're interested in working on nmh, but aren't sure what to do, see
-the TODO file in the docs subdirectory. There's plenty of work there.
-
-Working with your shell
------------------------
-The files COMPLETION-BASH, COMPLETION-TCSH and COMPLETION-ZSH in the
-docs subdirectory give cookbook examples of how to use the enhanced
-features of these shells with nmh. There is also a section in Jerry
-Peek's book covering nmh/MH and working with the shell. The section is
-available online at <http://rand-mh.sourceforge.net/book/mh/mhanthsh.html>.
-
-For More information
+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
+-----------
+Please send bug reports and suggestions to either Markus Schnalke
+<meillo@marmaro.de> or to the <nmh-workers@nongnu.org> mailing list.
+
+
+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. nmh is currently being
+developed and maintained by a loosely organized group of volunteers.
+
+
+For more information
 --------------------
-There is more information, including a FAQ and a bit of historical
-information in the docs subdirectory. There are also links to further
-documentation on the nmh website located at <http://nmh.nongnu.org/>.
+There is more information in the docs subdirectory. Please note that
+several documents are historic.
+
+The mmh website is located at <http://marmaro.de/prog/mmh/>.
+Feel free to contact Markus Schnalke <meillo@marmaro.de>.
+
+(The nmh website is located at <http://nmh.nongnu.org/>.)
index e9092a0..a9dfcc8 100644 (file)
@@ -12,7 +12,7 @@ VPATH  = @srcdir@
 FILES = COMPLETION-BASH COMPLETION-TCSH COMPLETION-ZSH               \
         ChangeLog_MH-3_to_MH-6.6 ChangeLog_MH-6.7.0_to_MH-6.8.4.html \
         ChangeLog_nmh DIFFERENCES_nmh_MH MACHINES \
-        FAQ README.mail-filtering MAILING-LISTS README.about    \
+        FAQ README.mail-filtering MAILING-LISTS \
         README.attachments README.hooks README.SASL                  \
         README.developers README.manpages TODO
 
diff --git a/docs/README.about b/docs/README.about
deleted file mode 100644 (file)
index 41f4482..0000000
+++ /dev/null
@@ -1,49 +0,0 @@
-#
-# README.about -- about nmh
-#
-
------------
-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.  If you have
-previously used MH, check the file DIFFERENCES for a list of the
-differences between nmh and MH (not up-to-date as of this writing).
-
-Although development of nmh is ongoing, it is generally stable and
-is in current use.  But it is possible that we may break things as
-changes are made.
-
---------------------------------
-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.
-
----------------
-nmh maintenance
----------------
-nmh is currently being developed and maintained by a loosely organized
-group of volunteers. General discussion of the development work takes
-place on the nmh-workers@nongnu.org mailing list. Please send bug
-reports and suggestions there.
-
-----------------
-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.
-
-nmh uses (v)snprintf code from the Apache web server, so we need to
-make the following acknowlegement:
-
-This product includes software developed by the Apache Group
-for use in the Apache HTTP server project (http://www.apache.org/).