Moved most of the documentation into a new "docs" subdirectory. Added a MAILING-LISTS...
[mmh] / README
1 #
2 # $Id$
3 #
4
5 Installing
6 ----------
7 Please read the INSTALL file.
8
9 Copying
10 -------
11 nmh uses a BSD-style license, which should be in the top-level of the
12 distribution in a file named COPYRIGHT.
13
14 Developers
15 ----------
16 Information of interest to nmh developers can be found in
17 the README.developers file in the docs subdirectory of this
18 distribution.  If you're hacking on the code, you should also
19 definately subscribe to the nmh-workers mailing list. To do so, send
20 mail to nmh-workers-request@mhost.com with the subject "subscribe". If
21 you're interested in working on nmh, but aren't sure what to do, see
22 the TODO file in the docs subdirectory. There's plenty of work there.
23
24 Working with your shell
25 -----------------------
26 The files COMPLETION-TCSH and COMPLETION-ZSH in the docs subdirectory
27 give cookbook examples of how to use the enhanced features of
28 these shells with nmh. There is also a section in Jerry Peek's book
29 covering nmh/MH and working with the shell. The section is available
30 online here: http://www.ics.uci.edu/~mh/book/mh/mhanthsh.htm
31
32 For More information
33 --------------------
34 There is more information, including a FAQ and a bit of historical
35 information in the docs subdirectory. There are also links to further
36 documentation on the nmh website located at http://www.mhost.com/nmh .
37