Changeset 12623


Ignore:
Timestamp:
04/18/10 10:01:49 (12 years ago)
Author:
Mark Evenson
Message:

Partial re-working of install documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/abcl/README

    r12563 r12623  
    33
    44Armed Bear Common Lisp is an implementation of ANSI Common Lisp that
    5 runs in a Java virtual machine.  It compiles its code to Java byte code.
     5runs in a Java virtual machine.  It compiles its code to Java byte
     6code.
    67
    78
     
    3839After you have downloaded a binary release archive, unzip or untar it
    3940into its own directory. To run ABCL directly from this directory, make
    40 sure Java (version 1.5 or up) is in your path. Then, type the following
    41 command:
     41sure Java (version 1.5 or up) is in your shell's path. Then issue following
     42command under UNIX
    4243
    43   $ java -jar abcl.jar
     44    unix$ ./abcl
    4445
    45 Which should result output like the following:
     46or under Windows
    4647
    47 ----------------
    48 Armed Bear Common Lisp 0.19.1
    49 Java 1.6.0_14 Sun Microsystems Inc.
    50 Java HotSpot(TM) Client VM
    51 Low-level initialization completed in 0.9 seconds.
    52 Startup completed in 2.294 seconds.
    53 Type ":help" for a list of available commands.
    54 CL-USER(1):
    55 ----------------
     48    dos$ abcl.bat
     49   
     50To start from within Java, one can specify the use of the JAR file
     51directly via:
    5652
    57 In order to build ABCL, you need the full SDK. However, in order to
    58 just run it (like the above), the JRE is enough.
     53   cmd$ java -jar abcl.jar
     54
     55Any of these method should result in output like the following:
     56
     57    Armed Bear Common Lisp 0.19.1
     58    Java 1.6.0_14 Sun Microsystems Inc.
     59    Java HotSpot(TM) Client VM
     60    Low-level initialization completed in 0.9 seconds.
     61    Startup completed in 2.294 seconds.
     62    Type ":help" for a list of available commands.
     63    CL-USER(1):
    5964
    6065
     
    6267========
    6368
    64 If you want to build ABCL, you have 3 options. The first option
    65 applies when you come from a lisp background. The second and thirds
    66 options are more appropriate when you come from Java development:
     69If you want to build ABCL the preferred (and most tested way) is to
     70use the Ant build tool.
    6771
    68  I)  Bootstrap ABCL using a Common Lisp implementation
    69      Supported implementations for this process: SBCL, CMUCL, OpenMCL,
    70      Allegro CL, LispWorks or CLISP.
     721. Use the Ant build tool for Java environments. 
    7173
    72 II)  Use the Ant make-like build tool for Java environments
    73      The tested lowest working version is Ant 1.7.0.
     742. Use the Netbeans 6.x IDE to open ABCL as a project.
    7475
    75 III) Use the Netbeans 6.x IDE to open ABCL as a project.
     763. Bootstrap ABCL using a Common Lisp implementation. Supported
     77   implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
     78   CL, LispWorks or CLISP.
    7679
    7780
    7881In both cases you need a supported JDK version (1.5 and 1.6 have been
    79 tested).  Just the JRE isn't enough.
     82tested).  Just the JRE isn't enough, as you need javac to compile
     83files.
    8084
    8185
     86Using Ant
     87---------
    8288
    83 I. Lisp-based build
    84 -------------------
     89Download a binary distribution [Ant version 1.7.1 or greater][1].
     90Unpack the files somewhere convenient, ensuring that the 'ant' (or
     91'ant.bat' under Windows) executable is in your path and executable.
     92
     93[1]: XXX
     94
     95Then simply executing
     96
     97    unix$  ant
     98
     99or
     100    cmd$ ant.bat   
     101
     102from the directory containing this README file will create an
     103executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).  Use
     104this wrapper to start ABCL.
     105
     106
     107Using NetBeans
     108--------------
     109
     110Obtain the [Netbeans IDE][2] One should be able to open the ABCL directory
     111as a project in Netbeans 6.x via the appropiate menu.
     112
     113[2]: XXX
     114
     115Building from Lisp
     116------------------
    85117
    86118Copy the file 'customizations.lisp.in' to customization.lisp', in the
    87119directory containing this README file, editing to suit your situation,
    88 paying attention to the comments in the file.
    89 
     120paying attention to the comments in the file.  The ciritical point is
     121to have **JDK** point to the root of the Java Development Kit. 
    90122
    91123Use ./build-from-lisp.sh <lisp-of-choice>, e.g.
     
    112144into limitations on command line length (but is a lot slower).
    113145
    114 
    115 II. Ant-based build
    116 -------------------
    117 
    118 With Ant in your path, executing
    119 
    120     ant -find build.xml abcl.wrapper
    121 
    122 from the directory containing this README file will create an
    123 executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).
    124 Use this wrapper to start the ABCL Java program.
    125 
    126 
    127 III. Netbeans-based build
    128 -------------------------
    129 
    130 One should be able to open the project as a project in Netbeans 6.x.
    131146
    132147
Note: See TracChangeset for help on using the changeset viewer.