partial doc update

1 files changed, 135 insertions, 103 deletions

diff --git a/INSTALL b/INSTALL
index 5ad226a..d0c3422 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,161 +1,190 @@
-1. Installing MDK
+Installing MDK
+**************
 
-     1.1 Download the source tarball
-     1.2 Requirements
-     1.3 Basic installation
-     1.4 Emacs support
-     1.5 Special configure flags
-     1.6 Supported platforms
+Download the source tarball
+===========================
 
-  ------------------------------------------------------------------------
-
-1.1 Download the source tarball
+   GNU MDK is distributed as a source tarball available for download in
+the following URLs:
 
-GNU MDK is distributed as a source tarball available for download in the
-following URLs:
+   * <ftp://ftp.gnu.org/pub/gnu/mdk> (or one of its mirrors
+     (http://www.gnu.org/prep/ftp.html))
 
-   * ftp://ftp.gnu.org/pub/gnu/mdk (or one of its mirrors)
-   * http://sourceforge.net/project/showfiles.php?group_id=13897
+   * `http://sourceforge.net/project/showfiles.php?group_id=13897'
 
-The above sites contain the latest stable releases of MDK. The development
-branch is available at:
+   The above sites contain the latest stable releases of MDK. The
+development branch is available at:
 
-   * https://savannah.gnu.org/cvs/?group_id=118
+   * `https://savannah.gnu.org/cvs/?group_id=118'
 
-After you have downloaded the source tarball, unpack it in a directory of
-your choice using the command:
+   After you have downloaded the source tarball, unpack it in a
+directory of your choice using the command:
 
-  tar xfvz mdk-X.Y.tar.gz
+     tar xfvz mdk-X.Y.tar.gz
 
 where X.Y stands for the downloaded version (the current stable release
-being version 0.3.2).
+being version {No value for `VERSION'}).
 
-  ------------------------------------------------------------------------
+Requirements
+============
 
-1.2 Requirements
+   In order to build and install MDK, you will need the following
+libraries installed in your system:
 
-In order to build and install MDK, you will need the following libraries
-installed in your system:
+   - GLIB 1.2.0 (http://www.gtk.org) (required)
 
-   * GLIB 1.2.0 (required)
-   * GNU Flex 2.3 (required)
-   * GTK+ 1.2.0 (optional)
-   * libglade (optional)
-   * GNU readline and history libraries (optional)
+   - GNU Flex 2.3 (http://www.gnu.org/software/flex/flex.html)
+     (required)
 
-If present, readline and history are used to provide command completion and
-history management to the command line MIX virtual machine, mixvm GTK+ and
-libglade are needed if you want to build the graphical interface to the MIX
-virtual machine, gmixvm.
+   - GTK 1.2.0 (http://www.gtk.org) (optional)
 
-Please note: you need both the libraries and the headers; this means both
-the library package and the `-dev' package if you do not compile your
-libraries yourself (ex: installing `libgtk1.2' and `libgtk1.2-dev' on
-Debian).
+   - Libglade (ftp://ftp.gnome.org/pub/GNOME/stable/sources/libglade/)
+     (optional)
 
-  ------------------------------------------------------------------------
+   - GNU Readline
+     (http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html)
+     (optional)
 
-1.3 Basic installation
+   - GNU Libguile 1.3 (http://www.gnu.org/software/guile) (optional)
 
-MDK uses GNU Autoconf and Automake tools, and, therefore, should be built
-and installed without hassle using the following commands inside the source
-directory:
+   If present, readline and history are used to provide command
+completion and history management to the command line MIX virtual
+machine, `mixvm'.  GTK+ and libglade are needed if you want to build
+the graphical interface to the MIX virtual machine, `gmixvm'. Finally,
+if libguile is found, the MDK utilities will be compiled with Guile
+support and will be extensible using Scheme.
 
-  ./configure
-  make
-  make install
+   *Please note*: you need both the libraries _and_ the headers; this
+means both the library package and the `-dev' package if you do not
+compile your libraries yourself (ex: installing `libgtk1.2' and
+`libgtk1.2-dev' on Debian).
 
-where the last one must be run as root.
+Basic installation
+==================
 
-The first command, configure, will setup the makefiles for your system. In
-particular, configure will look for GTK+ and libglade, and, if they are
-present, will generate the appropiate makefiles for building the gmixvm
-graphical user interface. Upon completion, you should see a message with the
-configuration results like the following:
+   MDK uses GNU Autoconf and Automake tools, and, therefore, should be
+built and installed without hassle using the following commands inside
+the source directory:
 
-  *** GNU MDK 0.3 has been successfully configured. ***
+     ./configure
+     make
+     make install
 
-  Type make to build the following utilities:
-      - mixasm (MIX assembler)
-      - mixvm (MIX virtual machine, with readline support)
-      - gmixvm (mixvm GTK+ GUI)
+where the last one must be run as root.
 
-where the last line may be missing if you lack the above mentioned
+   The first command, `configure', will setup the makefiles for your
+system. In particular, `configure' will look for GTK+ and libglade,
+and, if they are present, will generate the appropiate makefiles for
+building the `gmixvm' graphical user interface. Upon completion, you
+should see a message with the configuration results like the following:
+
+     *** GNU MDK 0.5 has been successfully configured. ***
+     
+     Type 'make' to build the following utilities:
+         - mixasm (MIX assembler)
+         - mixvm (MIX virtual machine, with readline support,
+	          with guile support)
+         - gmixvm (mixvm GTK+ GUI, with guile support)
+         - mixguile (the mixvm guile shell)
+
+where the last lines may be missing if you lack the above mentioned
 libraries.
 
-The next command, make, will actually build the MDK programs in the
-following locations:
+   The next command, `make', will actually build the MDK programs in
+the following locations:
 
-   * `mixutils/mixasm'
-   * `mixutils/mixvm'
-   * `mixgtk/gmixvm'
+   - `mixutils/mixasm'
 
-You can run these programs from within their directories, but I recommend
-you to install them in proper locations using make install from a root
-shell.
+   - `mixutils/mixvm'
 
-  ------------------------------------------------------------------------
+   - `mixgtk/gmixvm'
 
-1.4 Emacs support
+   - `mixguile/mixguile'
 
-mixvm can be run within an Emacs GUD buffer using the elisp program
-`misc/mixvm.el', kindly contributed by Philip E. King.
+   You can run these programs from within their directories, but I
+recommend you to install them in proper locations using `make install'
+from a root shell.
 
-`mixvm.el' provides an interface between MDK's mixvm and Emacs, via GUD.
-Place this file in your load-path, optionally adding the following line to
-your `.emacs' file:
+Emacs support
+=============
 
-  (autoload 'mixvm "mixvm" "mixvm/gud interaction" t)
+   `mixvm' can be run within an Emacs GUD buffer using the elisp
+program `misc/mixvm.el', kindly contributed by {No value for `PHILIP'}.
 
-  ------------------------------------------------------------------------
+   `mixvm.el' provides an interface between MDK's `mixvm' and Emacs,
+via GUD.  Place this file in your load-path, optionally adding the
+following line to your `.emacs' file:
 
-1.5 Special configure flags
+     (autoload 'mixvm "mixvm" "mixvm/gud interaction" t)
 
-You can fine tunning the configuration process using the following switches
-with configure:
+Special configure flags
+=======================
 
-User Option: --enable-gui[=yes|no]
-User Option: --disable-gui
-     Enables/disables the built of the MIX virtual machine GUI (gmixvm). If
-     the required libraries are missing (see section 1.2 Requirements) the
-     configure script with automatically disable this feature.
+   You can fine tunning the configuration process using the following
+switches with configure:
 
-User Option: --with-readline[=yes|no]
-User Option: --without-readline
-     Enables/disables the GNU Readline support for mixvm. If the required
-     libraries are missing (see section 1.2 Requirements) the configure
-     script with automatically disable this feature.
+ - User Option: -enable-gui[=yes|no]
+ - User Option: -disable-gui
+     Enables/disables the build of the MIX virtual machine GUI
+     (`gmixvm'). If the required libraries are missing (*note
+     Requirements::) the configure script with automatically disable
+     this feature.
 
-For additional, boilerplate configure options, see the `INSTALL' file, or
-run
+ - User Option: -with-guile[=yes|no]
+ - User Option: -without-guile
+     Enables/disables the Guile support for `mixvm' and `gmixvm', and
+     the build of `mixguile'.  If the required libraries are missing
+     (*note Requirements::) the configure script with automatically
+     disable this feature.
 
-  configure --help
+ - User Option: -with-readline[=yes|no]
+ - User Option: -without-readline
+     Enables/disables the GNU Readline support for `mixvm'.  If the
+     required libraries are missing (*note Requirements::) the configure
+     script with automatically disable this feature.
 
-  ------------------------------------------------------------------------
+   For additional, boilerplate configure options, see the
+   `Generic configure help' below, or run
+
+     configure --help
 
-1.6 Supported platforms
+Supported platforms
+===================
 
-GNU MDK has been tested in the following platforms:
+   GNU MDK has been tested in the following platforms:
 
    * Debian GNU/Linux 2.2/2.3
+
    * Redhat GNU/Linux 7.0 (Agustin Navarro), 6.2 (Roberto Ferrero)
-   * FreeBSD 4.2 (Ying-Chieh Liao)
+
+   * Mandrake 8.0 (Agustin Navarro)
+
+   * FreeBSD 4.2, 4.3 (Ying-Chieh Liao)
+
    * Solaris 2.8/gcc 2.95.3 (Stephen Ramsay)
+
    * MS Windows 98 SE/Cygwin 1.1.8-2 (Christoph von Nathusius)(1)
 
-(1) Caveats: Christoph has only tested mixvm and mixasm on this platform,
-using gcc 2.95.3-2, GLIB 1.2.10 and GNUreadline 4.1-2. He has reported
-missing history functionalities on a first try. If you find problems
-with history/readline functionality, please try a newer/manually
-installed readline version.
+   MDK will probably work on any GNU/Linux and BSD platform. If you try
+it in a platform not listed above, please send a mail to the author
+<jao@gnu.org>.
+
+   ---------- Footnotes ----------
+
+   (1) Caveats: Christoph has only tested `mixvm' and `mixasm' on this
+platform, using `gcc' 2.95.3-2, `GLIB' 1.2.10 and `GNUreadline' 4.1-2.
+He has reported missing history functionalities on a first try. If you
+find problems with history/readline functionality, please try a
+newer/manually installed readline version.
+
 
-MDK will probably work on any GNU/Linux and BSD platform. If you try it in a
-platform not listed above, please send a mail to the author.
 
   ------------------------------------------------------------------------
   ------------------------------------------------------------------------
  
-2. Generic configure help
+Generic configure help
+**********************
+
 
 Basic Installation
 ==================
@@ -336,3 +365,6 @@ find the X include and library files automatically, but if it doesn't,
 you can use the `configure' options `--x-includes=DIR' and
 `--x-libraries=DIR' to specify their locations.
 
+----
+
+$Id: INSTALL,v 1.4 2001/09/16 22:17:33 jao Exp $
\ No newline at end of file