Changeset 12900


Ignore:
Timestamp:
08/15/10 19:56:21 (12 years ago)
Author:
Mark Evenson
Message:

Correct README language.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/abcl/README

    r12625 r12900  
    3737===========================
    3838
    39 After you have downloaded a binary release archive, unzip or untar it
    40 into its own directory. To run ABCL directly from this directory, make
    41 sure Java (version 1.5 or up) is in your shell's path. Then issue
    42 following command
     39After you have downloaded a binary release archive unpack it into its
     40own directory. To run ABCL directly from this directory, make sure
     41Java (version 1.5 or up) is in your shell's path. Then issue following
     42command
    4343
    4444    cmd$ java -jar abcl.jar
     
    5858============================
    5959
    60 If you want to build ABCL forom source the preferred (and most tested
    61 way) is to use the Ant build tool.
     60There are three ways to build ABCL from the source release with the
     61preferred (and most tested way) is to being to use the Ant build tool:
    6262
    63 1. Use the Ant build tool for Java environments. 
     63* Use the Ant build tool for Java environments. 
    6464
    65 2. Use the Netbeans 6.x IDE to open ABCL as a project.
     65* Use the Netbeans 6.x IDE to open ABCL as a project.
    6666
    67 3. Bootstrap ABCL using a Common Lisp implementation. Supported
    68    implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
    69    CL, LispWorks or CLISP.
     67* Bootstrap ABCL using a Common Lisp implementation. Supported
     68  implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
     69  CL, LispWorks or CLISP.
    7070
    71 
    72 In both cases you need a supported JDK version (1.5 and 1.6 have been
    73 tested).  Just the JRE isn't enough, as you need javac to compile
    74 files.
     71In all cases you need a Java 5 or later JDK (JDK 1.5 and 1.6 have been
     72tested).  Just the JRE isn't enough, as you need the Java compiler
     73('javac') to compile the Java source of the ABCL implementation.
    7574
    7675
     
    10099
    101100Obtain and install the [Netbeans IDE][2]. One should be able to open
    102 the ABCL directory as a project in the Netbeans 6.x application.
     101the ABCL directory as a project in the Netbeans 6.x application,
     102whereupon the usual build, run, and debug targets as invoked in the
     103GUI are available.
    103104
    104105[2]: http://netbeans.org/downloads/
     
    114115don't want to know anything about Java.
    115116
    116 First, copy the file 'customizations.lisp.in' to customization.lisp', in the
    117 directory containing this README file, editing to suit your situation,
    118 paying attention to the comments in the file.  The ciritical point is
    119 to have **JDK** point to the root of the Java Development Kit.  There
    120 should be a `**JDK**/bin/javac' java compiler present. 
     117First, copy the file 'customizations.lisp.in' to customization.lisp',
     118in the directory containing this README file, editing to suit your
     119situation, paying attention to the comments in the file.  The critical
     120step is to have Lisp special variable '*JDK*' point to the root of the
     121Java Development Kit.  Underneath the directory referenced by the
     122value of '*JDK*' there should be an exectuable Java compiler in
     123'bin/javac' ('bin/java.exe' under Windows).
    121124
    122 Use ./build-from-lisp.sh <lisp-of-choice>, e.g.
     125Then, one may either use the 'build-from-lisp.sh' shell script or load
     126the necessary files into your Lisp image by hand.
     127
     128** Using the 'build-from-lisp.sh' script
     129
     130Under UNIX-like systems, you may simply invoke the
     131'build-from-lisp.sh' script as './build-from-lisp.sh
     132<lisp-of-choice>', e.g.
    123133
    124134    unix$ ./build-from-lisp.sh sbcl
    125135
    126 Use abcl.bat on Windows or ./abcl on Unix to start ABCL.
    127 Note: abcl.bat and abcl contain absolute paths, so you'll need
    128 to edit them if you move things around after the build.
    129 
     136After a successful build, you may use 'abcl.bat' on Windows or 'abcl'
     137on Unix to start ABCL.  Note that this wrappers contain absolute
     138paths, so you'll need to edit them if you move things around after the
     139build.
    130140
    131141If you're developing on ABCL, you may want to use
     
    141151This invokes javac separately for each .java file, which avoids running
    142152into limitations on command line length (but is a lot slower).
     153 
     154** Building from another Lisp by hand
    143155
    144 There is also an ASDF definition in 'abcl.asd' for BUILD-ABCL which
    145 can be used to load the necessary Lisp defintions, after which
    146 
     156There is also an ASDF definition in 'abcl.asd' for the BUILD-ABCL
     157which can be used to load the necessary Lisp definitions, after which
    147158
    148159    CL-USER> (build-abcl:build-abcl :clean t :full t)
    149160   
    150 will build ABCL.   
    151 
     161will build ABCL.  If ASDF isn't present, simply LOAD the
     162'customizations.lisp' and 'build-abcl.lisp' files to achieve the same
     163effect as loading the ASDF definition.
    152164
    153165
Note: See TracChangeset for help on using the changeset viewer.