git.marmaro.de Git - mmh/blob - README

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