X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=README;h=63037c282cb675453c854ab26703b6206e1ca4fb;hp=b61ba4cc8f047f2e25fc387f7e94c894869c5b5c;hb=4112940aea5591648b03a81907408752c08b33aa;hpb=6e31ed26e82a28c2f65197102c178e6ae8633d80 diff --git a/README b/README index b61ba4c..63037c2 100644 --- a/README +++ b/README @@ -1,32 +1,84 @@ +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 intended to be a drop-in replacement for nmh, +rather mmh breaks compatibility to nmh in order to modernize and +simplify it. + +Mmh is small and simple; nmh is established and matured; MH is ancient. + +Unfortunately, the usage of the terms `mmh' and `nmh' is not fully +consistent within the distribution. + + Installing ---------- -Please read the INSTALL file. +See the INSTALL file. + Copying ------- -nmh uses a BSD-style license, which should be in the top-level of the -distribution in a file named COPYRIGHT. +Mmh uses a BSD-style license, which can be found in the COPYRIGHT +file. + + +Users +----- +Start by 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 . -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 . - -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 . +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 mmh's mailing list. To +do so, send a message to with the subject +``subscribe''. + + +Changes +------- +See the NEWS file for a summary of changes between releases. See +the ChangeLog file (which is included in releases as a static copy +of the VCS log) for a more detailed list of changes. + + +Bug reports +----------- +Please send bug reports and suggestions to the mailing list: +. + + +Acknowledgments +--------------- +The MH system was originally developed by the RAND Corporation, +starting in 1979. It was written mainly 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. + + +More information +---------------- +There is more information in the docs subdirectory. Some of the +documents are historic, however. + +The mmh website is located at . +Feel free to write to mmh's mailing list at +or contact Markus Schnalke directly. + +(The nmh website is located at .)