----------------------------------------------------------------------
          isa-mode -- GNU Emacs support for Isabelle

                    Installation Instructions.
----------------------------------------------------------------------

Brief instructions:
==================

+ Edit isa-site.el
+ Edit Makefile
+ Run:  "make compile"  to make .elc files (optional)
+ Add this line to .emacs:  (load-file "<path>/isa-site")



Less-brief instructions:
========================


"installing" isa-mode.el is achieved by either of:

 1. LONG       Edit .emacs
 2. SHORT      Edit isa-site.el & .emacs 
 3. NOTHING    Edit a site default file (eg. default.el, site-run.el, 
					     site-init.el)

The mnemonics indicate how much work is needed in each user's .emacs
file to get isa-mode working.  The less you do to "install" the
package, the more each user has to do!

If several people at your site are going to use the software, it's
worth somebody editing a single master copy of isa-site.el -- "SHORT".
There aren't many changes to make.

Here is a description of the configuration changes.  If isa-site.el is
not edited, users will have to set these individually in their .emacs
as shown below.


A. Path variables.
-----------------

    (setq isa-install-dir        "<path to this directory>")
    (setq isa-builtin-logic-path "<path to builtin logics>")
    (setq isa-manual-path        "<path to Isabelle Doc directory>")

isa-install-dir points to the directory containing the isa-mode lisp
files to finally be used by Emacs: either the directory you unpacked
this distribution in, or somewhere else more appropriate.

isa-builtin-logic-path is like ISABELLEBIN for Isabelle Makefiles.

isa-manual-path should be the path to the directory "Doc" in the
Isabelle distribution.


B. Compiler choice.
------------------

   (setq isa-ml-compiler 'poly) ; for Poly/ML (default at present), or

   (setq isa-ml-compiler 'NJ)   ; for SML of New Jersey.

If you have both versions at your site, this variable might be set by
the user according to preference.

If things do not work correctly, you may need to change variables in
the file isa-ml-comp.el which defines the system commands used to
invoke Isabelle under each compiler.  If you have Isabelle built under
a different ML compiler, you will need to extend isa-ml-comp
accordingly.  See that file.


C. Byte compilation, "installation" to a global directory
---------------------------------------------------------

Edit the Makefile to set variables EMACS and (if required)
INSTALLDIR.   Then run

    make compile    - make byte-compiled .elc files
    make install    - to copy just .elc/.el files elsewhere

If you only want to use the package with one version of Emacs, you can
remove the "setq byte-compiler-compatibility" from isa-compdefs.el,
which may result in shorter/faster .elc files.  You can also retain
isa-menus.elc - it's presently deleted in Makefile because it contains
"easymenu" macros which get expanded during compilation.



D. User options.
---------------

There are numerous user options.  At present, these are documented
only inside the lisp files; you can list them in the usual way, with
M-x list-options.

Here's one handy one:

    (setq isa-use-multiple-screens nil)

Prevents multiple X-window usage in Emacs 19 varieties, to confine
the display to a single Emacs "screen" (aka "frame").


E. Local instructions.
---------------------

You should make a version of README.txt for local users; change the
instructions appropriately.






Please tell me of any problems or suggestions. 

				 	  David Aspinall, Feb 1994.
					  (da@dcs.ed.ac.uk)

