From: markus schnalke <meillo@marmaro.de>
Date: Thu, 22 Mar 2012 10:18:00 +0000 (+0100)
Subject: Updated the INSTALL file.
X-Git-Tag: mmh-thesis-end~255
X-Git-Url: http://git.marmaro.de/?p=mmh;a=commitdiff_plain;h=be0ae81623aea2eca09b8faf699b4b407f527267

Updated the INSTALL file.
---

diff --git a/INSTALL b/INSTALL
index 009d479..d93ff2c 100644
--- a/INSTALL
+++ b/INSTALL
@@ -24,28 +24,24 @@ need an ANSI C compiler such as gcc.
    docs/README.developers, since there is other developer-friendly
    advice there as well.)
 
-1) From the top-level source directory, run the command
+1) From the top-level source directory, run the command:
 
-   ./configure [options]
+       ./configure [options]
 
-   This will check the configuration of your OS, and create the 
-   include file config.h, as well as the various Makefiles.
+   This will check the configuration of your OS, as well as the various
+   Makefiles.
 
    The configure script accepts various options.  The options of 
    most interest are listed in a section below.  To see the list 
-   of all available options, you can run
+   of all available options, you can run:
 
-   ./configure --help
+       ./configure --help
 
-2) Look through the user configuration section at the beginning
-   of the generated include file `config.h'. You may
-   want to customize some #defines for your environment.
+2) make
 
-3) make
+3) make install
 
-4) make install
-
-   Note that if you have [n]mh files in your install directories with
+   Note that if you have mmh files in your install directories with
    the same names as the files being installed, the old ones will get
    overwritten without any warning.  The only directory this isn't
    true for, is the `etc' directory -- in that directory, the distributed
@@ -53,7 +49,7 @@ need an ANSI C compiler such as gcc.
    existing file.  Watch for information messages while make is processing
    that directory to see if you need to merge changes.
 
-5) Edit the file `mhn.defaults' (installed in the mmh `etc' directory).
+4) Edit the file `mhn.defaults' (installed in the mmh `etc' directory).
    This file contains the default profile entries for the mmh commands
    mhlist/mhstore/mhshow and is created by the script `mhn.defaults.sh'.
    This script will search a generic path (essentially your $PATH) for
@@ -62,8 +58,8 @@ need an ANSI C compiler such as gcc.
    path.  You may want to re-run this script later if you install new
    programs to display content.  An example of this is:
 
-    % cd support/general
-    % ./mhn.defaults.sh /usr/local/bin:/usr/X11/bin:/usr/ucb > mhn.defaults
+       % cd support/general
+       % ./mhn.defaults.sh /usr/local/bin:/usr/ucb > mhn.defaults
 
    and then move `mhn.defaults' into the mmh `etc' directory.
 
@@ -74,6 +70,13 @@ need an ANSI C compiler such as gcc.
    Programmers", 3rd edition, by Jerry Peek, on the Internet at
    <http://www.ics.uci.edu/~mh/book/mh/confmhn.htm>.
 
+5) Add the bindir to your PATH variable.
+
+   If you haven't change any paths, then the bindir is `/usr/local/mmh/bin'.
+   Likely, your PATH is set in ~/.profile, ~/.kshrc, ~/.bashrc, or a similar
+   file.
+
+
 -----------------------------------------------
 Compiler options, or using a different compiler
 -----------------------------------------------
@@ -124,9 +127,11 @@ Options for configure
 
 --bindir=DIR     (DEFAULT is ${prefix}/bin)
      mmh's binaries (show, inc, comp, ...) are installed here.
+     You need to have this directory in your PATH variable.
 
 --libdir=DIR     (DEFAULT is ${prefix}/lib)
-     mmh's support binaries (spost, slocal, mhl, ...) are installed here.
+     mmh's test tools (ap, dp, mhtest, ...) are installed here.
+     They are seldom useful to normal users.
 
 --sysconfdir=DIR     (DEFAULT is ${prefix}/etc)
      mmh's config files (mhn.defaults, ...) are installed here.