source: trunk/abcl/README @ 12625

Last change on this file since 12625 was 12625, checked in by Mark Evenson, 13 years ago

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

  • Property svn:eol-style set to native
File size: 5.7 KB
Line 
1GENERAL INFORMATION
2===================
3
4Armed Bear Common Lisp is an implementation of ANSI Common Lisp that
5runs in a Java virtual machine.  It compiles its code to Java byte
6code.
7
8
9LICENSE
10=======
11
12Armed Bear Common Lisp is distributed under the GNU General Public
13License with classpath exception (described below).
14
15A copy of GNU General Public License (GPL) is included in this
16distribution, in the file COPYING.
17
18Linking this software statically or dynamically with other modules is
19making a combined work based on this software. Thus, the terms and
20conditions of the GNU General Public License cover the whole
21combination.
22
23As a special exception, the copyright holders of this software give
24you permission to link this software with independent modules to
25produce an executable, regardless of the license terms of these
26independent modules, and to copy and distribute the resulting
27executable under terms of your choice, provided that you also meet,
28for each linked independent module, the terms and conditions of the
29license of that module. An independent module is a module which is not
30derived from or based on this software. If you modify this software,
31you may extend this exception to your version of the software, but you
32are not obligated to do so. If you do not wish to do so, delete this
33exception statement from your version.
34
35
36RUNNING FROM BINARY RELEASE
37===========================
38
39After you have downloaded a binary release archive, unzip or untar it
40into its own directory. To run ABCL directly from this directory, make
41sure Java (version 1.5 or up) is in your shell's path. Then issue
42following command
43
44    cmd$ java -jar abcl.jar
45
46which should result in output like the following
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
56
57BUILDING FROM SOURCE RELEASE
58============================
59
60If you want to build ABCL forom source the preferred (and most tested
61way) is to use the Ant build tool.
62
631. Use the Ant build tool for Java environments. 
64
652. Use the Netbeans 6.x IDE to open ABCL as a project.
66
673. Bootstrap ABCL using a Common Lisp implementation. Supported
68   implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
69   CL, LispWorks or CLISP.
70
71
72In both cases you need a supported JDK version (1.5 and 1.6 have been
73tested).  Just the JRE isn't enough, as you need javac to compile
74files.
75
76
77Using Ant
78---------
79
80Download a binary distribution [Ant version 1.7.1 or greater][1].
81Unpack the files somewhere convenient, ensuring that the 'ant' (or
82'ant.bat' under Windows) executable is in your path and executable.
83
84[1]: http://ant.apache.org/bindownload.cgi
85
86Then simply executing
87
88    unix$  ant
89
90or
91    cmd$ ant.bat   
92
93from the directory containing this README file will create an
94executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).  Use
95this wrapper to start ABCL.
96
97
98Using NetBeans
99--------------
100
101Obtain and install the [Netbeans IDE][2]. One should be able to open
102the ABCL directory as a project in the Netbeans 6.x application.
103
104[2]: http://netbeans.org/downloads/
105
106
107Building from Lisp
108------------------
109
110Building from a Lisp is the most venerable and untested way of
111building ABCL.  It produces a "non-standard" version of the
112distribution that doesn't share build instructions with the previous
113two methods, but it still may be of interest to those who absolutely
114don't want to know anything about Java.
115
116First, copy the file 'customizations.lisp.in' to customization.lisp', in the
117directory containing this README file, editing to suit your situation,
118paying attention to the comments in the file.  The ciritical point is
119to have **JDK** point to the root of the Java Development Kit.  There
120should be a `**JDK**/bin/javac' java compiler present. 
121
122Use ./build-from-lisp.sh <lisp-of-choice>, e.g.
123
124    unix$ ./build-from-lisp.sh sbcl
125
126Use abcl.bat on Windows or ./abcl on Unix to start ABCL.
127Note: abcl.bat and abcl contain absolute paths, so you'll need
128to edit them if you move things around after the build.
129
130
131If you're developing on ABCL, you may want to use
132
133    unix$ ./build-from-lisp.sh <implementation> --clean=nil
134
135to not do a full rebuild.
136
137In case of failure in the javac stage, you might try this:
138
139    unix$ ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil
140
141This invokes javac separately for each .java file, which avoids running
142into limitations on command line length (but is a lot slower).
143
144There is also an ASDF definition in 'abcl.asd' for BUILD-ABCL which
145can be used to load the necessary Lisp defintions, after which
146
147
148    CL-USER> (build-abcl:build-abcl :clean t :full t)
149   
150will build ABCL.   
151
152
153
154BUGS
155====
156
157A lot of (renewed) energy has been spent to make ABCL a compliant
158and practically useable Common Lisp implementation.  Because of this,
159ABCL 0.19.1 now fails only 29 out of 21702 tests in the ANSI CL test
160suite.  Next to that, the fail count of the Maxima test suite has been
161reduced to only 5 - rounding errors.
162
163ABCL's CLOS does not handle on-the-fly redefinition of classes
164correctly. Quite a bit of energy has been spent in versions 0.16.0 and
1650.17.0 to improve CLOS performance. There is no support for the long
166form of DEFINE-METHOD-COMBINATION, and certain other required CLOS
167features are also missing. Enough CLOS is there to run
168ASDF2 and CL-PPCRE.
169
170There is no MOP worth mentioning.
171
172Patches to address any of the issues mentioned above will be gladly
173accepted.
174
175Please report problems to the development mailing list:
176
177    armedbear-devel@common-lisp.net
178
179Have fun!
180
181On behalf of all ABCL development team and contributors,
182Erik Huelsmann
183March 20, 2010
Note: See TracBrowser for help on using the repository browser.