minor changes

1 files changed, 130 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
index 421bc5c..0e5eb99 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,133 @@
+1. 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 Generic configure help
+
+1.1 Download the source tarball
+-------------------------------
+
+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://sourceforge.net/project/showfiles.php?group_id=13897
+
+The above sites contain the latest stable releases of MDK. The development
+branch is available at:
+
+   * http://sourceforge.net/cvs/?group_id=13897
+
+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
+
+where X.Y stands for the downloaded version (the current stable release
+being version ).
+
+
+1.2 Requirements
+----------------
+
+In order to build and install MDK, you will need the following libraries
+installed in your system:
+
+   * GLIB 1.2.0 (required)
+   * GNU Flex 2.3 (required)
+   * GTK+ 1.2.0 (optional)
+   * libglade (optional)
+   * GNU readline and history libraries (optional)
+
+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.
+
+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).
+
+
+1.3 Basic installation
+----------------------
+
+MDK uses GNU Autoconf and Automake tools, and, therefore, should be built
+and installed without hassle using the following commands inside the source
+directory:
+
+  ./configure
+  make
+  make install
+
+where the last one must be run as root.
+
+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.3 has been successfully configured. ***
+
+  Type make to build the following utilities:
+      - mixasm (MIX assembler)
+      - mixvm (MIX virtual machine, with readline support)
+      - gmixvm (mixvm GTK+ GUI)
+
+where the last line may be missing if you lack the above mentioned
+libraries.
+
+The next command, make, will actually build the MDK programs in the
+following locations:
+
+   * `mixutils/mixasm'
+   * `mixutils/mixvm'
+   * `mixgtk/gmixvm'
+
+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.
+
+1.4 Emacs support
+-----------------
+
+mixvm can be run within an Emacs GUD buffer using the elisp
+program misc/mixvm.el, kindly contributed by Philip King.
+
+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:
+
+(autoload 'mixvm "mixvm" "mixvm/gud interaction" t)
+
+
+1.5 Special configure flags
+---------------------------
+
+You can fine tunning the configuration process using the following switches
+with configure:
+
+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.
+
+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.
+
+
+1.6 Generic configure help
+--------------------------
+
 Basic Installation
 ==================