[armedbear-cvs] r12625 - trunk/abcl

[Mark Evenson]

Author: mevenson
Date: Sun Apr 18 06:02:03 2010
New Revision: 12625

Log:
Finish updating README, mainly deprecating the prominence of the Lisp build.



Modified:
   trunk/abcl/README

Modified: trunk/abcl/README
==============================================================================
--- trunk/abcl/README	(original)
+++ trunk/abcl/README	Sun Apr 18 06:02:03 2010
@@ -38,21 +38,12 @@
 
 After you have downloaded a binary release archive, unzip or untar it
 into its own directory. To run ABCL directly from this directory, make
-sure Java (version 1.5 or up) is in your shell's path. Then issue following
-command under UNIX
+sure Java (version 1.5 or up) is in your shell's path. Then issue
+following command
 
-    unix$ ./abcl
+    cmd$ java -jar abcl.jar
 
-or under Windows
-
-    dos$ abcl.bat
-    
-To start from within Java, one can specify the use of the JAR file
-directly via:
-
-   cmd$ java -jar abcl.jar
-
-Any of these method should result in output like the following:
+which should result in output like the following
 
     Armed Bear Common Lisp 0.19.1
     Java 1.6.0_14 Sun Microsystems Inc.
@@ -63,11 +54,11 @@
     CL-USER(1):
 
 
-BUILDING
-========
+BUILDING FROM SOURCE RELEASE
+============================
 
-If you want to build ABCL the preferred (and most tested way) is to
-use the Ant build tool.
+If you want to build ABCL forom source the preferred (and most tested
+way) is to use the Ant build tool.
 
 1. Use the Ant build tool for Java environments.  
 
@@ -90,7 +81,7 @@
 Unpack the files somewhere convenient, ensuring that the 'ant' (or
 'ant.bat' under Windows) executable is in your path and executable.
 
-[1]: XXX
+[1]: http://ant.apache.org/bindownload.cgi
 
 Then simply executing
 
@@ -107,22 +98,30 @@
 Using NetBeans
 --------------
 
-Obtain the [Netbeans IDE][2] One should be able to open the ABCL directory
-as a project in Netbeans 6.x via the appropiate menu.
+Obtain and install the [Netbeans IDE][2]. One should be able to open
+the ABCL directory as a project in the Netbeans 6.x application.
+
+[2]: http://netbeans.org/downloads/
 
-[2]: XXX
 
 Building from Lisp
 ------------------
 
-Copy the file 'customizations.lisp.in' to customization.lisp', in the
+Building from a Lisp is the most venerable and untested way of
+building ABCL.  It produces a "non-standard" version of the
+distribution that doesn't share build instructions with the previous
+two methods, but it still may be of interest to those who absolutely
+don't want to know anything about Java.
+
+First, copy the file 'customizations.lisp.in' to customization.lisp', in the
 directory containing this README file, editing to suit your situation,
 paying attention to the comments in the file.  The ciritical point is
-to have **JDK** point to the root of the Java Development Kit.  
+to have **JDK** point to the root of the Java Development Kit.  There
+should be a `**JDK**/bin/javac' java compiler present.  
 
 Use ./build-from-lisp.sh <lisp-of-choice>, e.g.
 
-  ./build-from-lisp.sh sbcl
+    unix$ ./build-from-lisp.sh sbcl
 
 Use abcl.bat on Windows or ./abcl on Unix to start ABCL.
 Note: abcl.bat and abcl contain absolute paths, so you'll need
@@ -131,18 +130,25 @@
 
 If you're developing on ABCL, you may want to use
 
-  ./build-from-lisp.sh <implementation> --clean=nil
+    unix$ ./build-from-lisp.sh <implementation> --clean=nil
 
 to not do a full rebuild.
 
-
 In case of failure in the javac stage, you might try this:
 
-  ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil
+    unix$ ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil
 
 This invokes javac separately for each .java file, which avoids running
 into limitations on command line length (but is a lot slower).
 
+There is also an ASDF definition in 'abcl.asd' for BUILD-ABCL which
+can be used to load the necessary Lisp defintions, after which 
+
+
+    CL-USER> (build-abcl:build-abcl :clean t :full t)
+    
+will build ABCL.    
+
 
 
 BUGS