Changeset 11352


Ignore:
Timestamp:
10/13/08 11:57:19 (13 years ago)
Author:
ehuelsmann
Message:

README updates in preparation of a release.

Patch by: Mark Evenson.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/j/README

    r10160 r11352  
    11GENERAL INFORMATION
    2 -------------------
     2===================
    33
    4 Armed Bear Common Lisp is an implementation of ANSI Common Lisp that runs in a
    5 Java virtual machine.
     4Armed Bear Common Lisp is an implementation of ANSI Common Lisp that
     5runs in a Java virtual machine.
    66
    77
    88LICENSE
    9 -------
     9=======
    1010
    11 Armed Bear Common Lisp is distributed under the GNU General Public License
    12 (with a special exception described below).
     11Armed Bear Common Lisp is distributed under the GNU General Public
     12License (with a special exception described below).
    1313
    14 A copy of GNU General Public License (GPL) is included in this distribution, in
    15 the file COPYING.
     14A copy of GNU General Public License (GPL) is included in this
     15distribution, in the file COPYING.
    1616
    17 Linking this software statically or dynamically with other modules is making a
    18 combined work based on this software. Thus, the terms and conditions of the GNU
    19 General Public License cover the whole combination.
     17Linking this software statically or dynamically with other modules is
     18making a combined work based on this software. Thus, the terms and
     19conditions of the GNU General Public License cover the whole
     20combination.
    2021
    21 As a special exception, the copyright holders of this software give you
    22 permission to link this software with independent modules to produce an
    23 executable, regardless of the license terms of these independent modules, and
    24 to copy and distribute the resulting executable under terms of your choice,
    25 provided that you also meet, for each linked independent module, the terms and
    26 conditions of the license of that module. An independent module is a module
    27 which is not derived from or based on this software. If you modify this
    28 software, you may extend this exception to your version of the software, but
    29 you are not obligated to do so. If you do not wish to do so, delete this
     22As a special exception, the copyright holders of this software give
     23you permission to link this software with independent modules to
     24produce an executable, regardless of the license terms of these
     25independent modules, and to copy and distribute the resulting
     26executable under terms of your choice, provided that you also meet,
     27for each linked independent module, the terms and conditions of the
     28license of that module. An independent module is a module which is not
     29derived from or based on this software. If you modify this software,
     30you may extend this exception to your version of the software, but you
     31are not obligated to do so. If you do not wish to do so, delete this
    3032exception statement from your version.
    3133
    3234
    33 INSTALLATION
    34 ------------
     35BUILDING
     36========
    3537
    36 To build ABCL, you'll need a 1.4 or 1.5 JDK and a supported Common Lisp
    37 implementation (SBCL, CMUCL, OpenMCL, Allegro, LispWorks, or CLISP).
     38To build ABCL, you'll need
    3839
    39 Edit the file customizations.lisp, in the directory containing this README
    40 file, to suit your situation, paying attention to the comments in the file.
     401)  a 1.5 JDK,
    4141
    42 Start up one of the supported Common Lisp implementations in the directory
    43 containing this README file.
     42and either
     43
     442.1) a supported Common Lisp implementation (SBCL, CMUCL, OpenMCL,
     45     Allegro, LispWorks, or CLISP)
     46
     47or
     48
     492.2) a version of Apache Ant (post 1.7.1)
     50
     51
     52Lisp-based
     53----------
     54
     55Copy the file 'customizations.lisp.in' to customization.lisp', in the
     56directory containing this README file, editing to suit your situation,
     57paying attention to the comments in the file.
     58
     59Start up one of the supported Common Lisp implementations in the
     60directory containing this README file.
    4461
    4562Load build-abcl.lisp:
     
    5370Wait for the build to finish and exit the host Lisp.
    5471
    55 Use abcl.bat on Windows or ./abcl on Unix to start ABCL. (Note that abcl.bat
    56 and abcl contain absolute paths, so you'll need to edit the relevant file if
    57 you move things around after the build.)
     72Use abcl.bat on Windows or ./abcl on Unix to start ABCL. (Note that
     73abcl.bat and abcl contain absolute paths, so you'll need to edit the
     74relevant file if you move things around after the build.)
    5875
    59 If the build fails in the javac stage, you might have better luck with this:
     76If the build fails in the javac stage, you might have better luck with
     77this:
    6078
    6179    (build-abcl:build-abcl :clean t :full t :batch nil)
    6280
    63 This invokes javac separately for each .java file, which is considerably slower
    64 but avoids running into limitations on command line length.
     81This invokes javac separately for each .java file, which is
     82considerably slower but avoids running into limitations on command
     83line length.
     84
     85Ant-based
     86---------
     87
     88With ant-1.7.1 in your path executing
     89
     90    ant -find build.xml abcl.wrapper
     91
     92from the directory containing this README file will create an
     93executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows) which
     94can use to run ABCL.
    6595
    6696
    6797BUGS
    68 ----
     98====
    6999
    70 ABCL is a very young implementation. You are certain to encounter bugs.
     100ABCL is a very young implementation. You are certain to encounter
     101bugs.
    71102
    72103ABCL 0.0.9 fails 54 out of 21344 tests in the GCL ANSI test suite.
    73104
    74 ABCL's CLOS does not handle on-the-fly redefinition of classes correctly, and
    75 in any event is intolerably slow. There is no support for the long form of
    76 DEFINE-METHOD-COMBINATION, and certain other required CLOS features are also
    77 missing. Enough CLOS is there to run ASDF and CL-PPCRE, if you're in no hurry.
     105ABCL's CLOS does not handle on-the-fly redefinition of classes
     106correctly, and in any event is intolerably slow. There is no support
     107for the long form of DEFINE-METHOD-COMBINATION, and certain other
     108required CLOS features are also missing. Enough CLOS is there to run
     109ASDF and CL-PPCRE, if you're in no hurry.
    78110
    79111There is no MOP worth mentioning.
    80112
    81 Since this is a very early public release, there might be build problems as
    82 well as runtime bugs.
     113Since this is a very early public release, there might be build
     114problems as well as runtime bugs.
    83115
    84116Please report problems to the j-devel mailing list:
Note: See TracChangeset for help on using the changeset viewer.