X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=README;h=1f74073594c48e38fae5d20cc2ee324f7fc1a85a;hp=595e444d76f70f7764be539f847a9591be2b6d8d;hb=1513f7668c494c4583141d6115669b7198c14556;hpb=1691e80890e5d8ba258c51c214a3e91880e1db2b diff --git a/README b/README index 595e444..1f74073 100644 --- a/README +++ b/README @@ -1,56 +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 I 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 -Richard Coleman . Please send bug reports -and suggestions to the nmh development mailing list at -nmh-workers@math.gatech.edu. - ----------------- -acknowledgments ----------------- -I would like to give credit where it is due. nmh could never have -been developed without all the hard work that the RAND Corporation -and the University of California put into the development of the -MH message system, that nmh is based on. - -Also, since I've used the version of (v)snprintf() from the -Apache web server, I 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/). +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/ . --- -Richard Coleman -coleman@math.gatech.edu -http://www.math.gatech.edu/~coleman/