X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=README;h=1f74073594c48e38fae5d20cc2ee324f7fc1a85a;hp=a4e21cdd2ded6dffadd9fc47ddc656b6795bda46;hb=389877bae1fe1a9f7259b8979f6a930744d90fab;hpb=c9f5db670ffbc6e761fb0512e621f2aee71509ee diff --git a/README b/README index a4e21cd..1f74073 100644 --- a/README +++ b/README @@ -1,52 +1,38 @@ # -# README -- I love README files. -# # $Id$ # ------------ -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. - ---------------- -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. - -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: +Installing +---------- +Please read 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. + +Developers +---------- +Information of interest to nmh 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 here: http://www.ics.uci.edu/~mh/book/mh/mhanthsh.htm + +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/ . -This product includes software developed by the Apache Group -for use in the Apache HTTP server project (http://www.apache.org/).