README
author lcp
Fri May 13 11:10:14 1994 +0200 (1994-05-13)
changeset 370 e95e212512d1
parent 196 7646f5b4653c
child 470 6cb6dd05d761
permissions -rw-r--r--
make-all-poly, make-all-nj: restored to main directory as examples
README: modified accordingly
     1 		     ISABELLE-93 DISTRIBUTION DIRECTORY
     2 
     3 ------------------------------------------------------------------------------
     4 ISABELLE-93 IS INCOMPATIBLE WITH EARLIER VERSIONS.  PLEASE CONSULT THE
     5 DOCUMENTATION.
     6 ------------------------------------------------------------------------------
     7 
     8 This directory contains the complete Isabelle system.  To build and test the
     9 entire system, including all object-logics, use the shell script make-all.
    10 Pure Isabelle and each of the object-logics can be built separately using the
    11 Makefiles in the respective directories; read them for more information.
    12 
    13 				THE MAKEFILES
    14 
    15 The Makefiles can use two different Standard ML compilers: Poly/ML version
    16 2.03 or later (from Abstract Hardware Ltd) and Standard ML of New Jersey
    17 (Version 0.93 or later).  Poly/ML is a commercial product and costs money,
    18 but it is reliable and its database system is convenient for interactive
    19 work.  SML of New Jersey requires lots of store and disc space, but it is
    20 free and its code sometimes runs faster.  Both compilers are perfectly
    21 satisfactory for running Isabelle.
    22 
    23 The Makefiles and make-all use environment variables that you should set
    24 according to your site configuration.  See file make-all-nj for an example
    25 using the Bourne shell, sh.
    26 
    27 ISABELLEBIN is the directory to hold Poly/ML databases or New Jersey ML
    28 images.  When using Poly/ML, ISABELLEBIN must be an absolute pathname (one
    29 starting with "/").
    30 
    31 ML_DBASE is an *absolute* pathname to the initial Poly/ML database (not
    32 required for New Jersey ML).
    33 
    34 ISABELLECOMP is the ML compiler, typically "poly -noDisplay" or "sml".  If
    35 ISABELLECOMP begins with the letters "poly" then the Makefiles assume that
    36 it is Poly/ML; if it begins with the letters "sml" then they assume
    37 Standard ML of New Jersey.  
    38 
    39 If a Poly/ML session fails with the message "Run out of store" then you
    40 have used up the entire heap.  If your tactic is not in a loop, allocating
    41 more heap at startup should correct the problem.  For instance, "poly -h
    42 15000" allocates sufficient heap space to rebuild all Isabelle examples.
    43 
    44 
    45 			 STRUCTURE OF THIS DIRECTORY
    46 
    47 The directory Pure containes pure Isabelle, which has no object-logic.
    48 
    49 Other important files include...
    50   COPYRIGHT   		Copyright notice and Disclaimer of Warranty
    51   make-all		shell script for building entire system
    52   make-all-poly		sample make-all invocation for Poly/ML
    53   make-all-nj		sample make-all invocation for SML of NJ
    54   change_simp		shell script to help convert sources to new simplifier
    55   expandshort		shell script to expand "shortcuts" in files
    56   prove_goal.el       	Emacs command to change proof format
    57   xlisten		shell script for running Isabelle under X
    58   teeinput		shell script to run Isabelle, logging inputs to a file
    59   Pure			directory of source files for Pure Isabelle
    60   Provers		directory of generic theorem provers
    61 
    62 xlisten sets up a window running Isabelle, with a separate small "listener"
    63 window, which keeps a log of all input lines.  This log is a useful record
    64 of a session.  If you are not running X windows, teeinput can still be used at
    65 least to record (if not to display) the log.
    66 
    67 The following subdirectories contain object-logics:
    68   FOL 	  Natural deduction First-Order Logic (intuitionistic and classical)
    69   FOLP 	  First-Order Logic with Proof terms
    70   ZF	  Zermelo-Fraenkel set theory
    71   HOL	  Classical Higher-Order Logic
    72   LCF     Logic for Computable Functions (domain theory) built upon FOL
    73   HOLCF   A version of LCF built upon HOL
    74   CTT	  Constructive Type Theory
    75   LK	  Classical first-order sequent calculus
    76   Modal	  The modal logics T, S4, S43
    77   CCL	  Martin Coen's Classical Computational Logic
    78   Cube	  Barendregt's Lambda Cube
    79 
    80 Object-logics include examples files in subdirectory ex or file ex.ML.
    81 These files can be loaded in batch mode.  The commands can also be
    82 executed interactively, using the windows on your workstation.  This is a
    83 good way to get started.
    84 
    85 Each object-logic is built on top of Pure Isabelle, and possibly on top of
    86 another object logic like FOL or LK.  A database or binary called Pure is
    87 first created, then the object-logic is loaded on top.  Poly/ML extends
    88 Pure using its "make_database" operation.  Standard ML of New Jersey starts
    89 with the Pure core image and loads the object-logic's ROOT.ML.
    90 
    91 		HOW TO GET A STANDARD ML COMPILER
    92 
    93 To obtain Poly/ML, contact Mike Crawley <mjc@ahl.co.uk> at Abstract
    94 Hardware Ltd, The Howell Building, Brunel University, Uxbridge UB8 3PH,
    95 England.
    96 
    97 To obtain Standard ML of New Jersey, contact David MacQueen
    98 <dbm@com.att.research> at AT&T Bell Laboratories, 600 Mountain Avenue,
    99 Murray Hill, NJ 07974, USA.  This compiler is available by FTP.  Connect to
   100 research.att.com; login as anonymous with your userid as password; set
   101 binary mode; transfer files from the directory dist/ml.
   102 
   103 ------------------------------------------------------------------------------
   104 
   105 The electronic mailing list isabelle-users@cl.cam.ac.uk provides a forum
   106 for Isabelle users to discuss problems and exchange information.  To join,
   107 send a message to isabelle-users-request@cl.cam.ac.uk.
   108 
   109 ------------------------------------------------------------------------------
   110 
   111 Please report any problems you encounter.  While we shall try to be helpful,
   112 we can accept no responsibility for the deficiences of Isabelle and their
   113 consequences.
   114 
   115 Lawrence C Paulson		E-mail: lcp@cl.cam.ac.uk
   116 Computer Laboratory 		Phone: +44-223-334600
   117 University of Cambridge 	Fax:   +44-223-334748 
   118 Pembroke Street 
   119 Cambridge CB2 3QG 
   120 England
   121 
   122 Tobias Nipkow			E-mail: nipkow@informatik.tu-muenchen.de
   123 Institut fuer Informatik	Phone: +49-89-2105-2690
   124 T. U. Muenchen			Fax:   +49-89-2105-8183
   125 D-80290 Muenchen
   126 Germany
   127 
   128 Last updated 13 May 1994