head     1.1;
access   ;
symbols  ;
locks    ; strict;
comment  @# @;


1.1
date     88.04.20.16.00.50;  author jed;  state Exp;
branches ;
next     ;


desc
@@



1.1
log
@Initial revision
@
text
@
To bring up Frobs at a new site:
--------------------------------

  * Connect to the frobs/ directory.

  * Edit variables CL, OBJ, LSP, and QUIT in the Makefile for your Lisp.
    Typical settings for these variables:

     Lisp   CL    OBJ    LSP    QUIT
     ---------------------------------------
     hpcl:  cl     b      l    sys:exit
     pcls:  pcls   b      l    sys:quit
      kcl:  kcl    o      l
    lucid:  lisp  lbin  lisp   sys:quit

  * Modify BIN to reflect the location of binaries for install.

  * Modify the install: make target to something like
       "rcp $(KERNEL) $(FROBS) $(BIN)"
       "rcp $(LOAD) require-path"
    where require-path is on your Common Lisp (require ...) path.

  * Run "make frobs" - should complete without errors.  The result of this
    is a set of binaries, and a load-file, frobs.$(OBJ), which loads all of
    the binaries.  This file can be put on your system require path.

  * Run "make aux" - if you want to try p-frobs (persistent frobs), an
    experimental and unsupported extension to frobs.  See the manual for
    details.

  * Run "make install" - if desired, to put the binaries on BIN.

  * Run "make doc" - to build the manual (LaTeX required).

  * Run "make test" - to run frobs on the test files in the examples
    subdirectory.



Porting to a new Lisp:
----------------------

Frobs can be tricky to port to a new Lisp.  Because frobs uses large macros
that have side-effects at macro expansion time, it can give a Lisp compiler
headaches.  We suggest that you first try loading frobs interpretively.
After loading frobs, try loading examples/ships.l and see if it runs without
problems.  It should print various things about firing missles at ships and
Libya.  This will give you an idea of whether frobs works at all with your
Lisp.

Frobs has many inter-file variable and macro dependencies (hey, it's an MS
thesis).  As you begin to compile files, you will notice that many frobs
files are preloaded for the compilation of other files.  If you build the
system without the Makefile, make sure, for each file compilation, that you
load the files that would have been loaded by the Makefile if it had done
the compilation.

We have had some package problems in various Lisp implementations.  The
simplest solution has been to put all exports into one file, pack.l.
Package name conflicts, if any arise, will have to be taken care of by
renaming either frobs symbols or symbols in other packages.

The make process used here, using Unix echo to send forms to Lisp, may not
work on all Unix machines.  You may have to rewrite the Makefile to load
files and run scripts in this case.

Please contact us if we can help...
@
