source: trunk/abcl/README @ 11485

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

Updated README to mention newly added Netbeans integration.

  • Property svn:eol-style set to native
File size: 4.2 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 code.
6
7
8LICENSE
9=======
10
11Armed Bear Common Lisp is distributed under the GNU General Public
12License with classpath exception (described below).
13
14A copy of GNU General Public License (GPL) is included in this
15distribution, in the file COPYING.
16
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.
21
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
32exception statement from your version.
33
34
35BUILDING
36========
37
38If you want to build ABCL, you have 2 options. The first option
39applies when you come from a lisp background. The second option is more
40appropriate when you come from Java development:
41
42 I)  Bootstrap ABCL using a Common Lisp implementation
43     Supported implementations for this process: SBCL, CMUCL, OpenMCL,
44     Allegro CL, LispWorks or CLISP.
45
46II)  Use the Ant make-like build tool for Java environments
47     The tested lowest working version is Ant 1.7.0.
48
49III) Use the Netbeans 6.x IDE to open ABCL as a project.
50
51
52In both cases you need a supported JDK version (1.5 and 1.6 have been
53tested).  Just the JRE isn't enough.
54
55
56
57I. Lisp-based build
58-------------------
59
60Copy the file 'customizations.lisp.in' to customization.lisp', in the
61directory containing this README file, editing to suit your situation,
62paying attention to the comments in the file.
63
64Start up one of the supported Common Lisp implementations in the
65directory containing this README file.
66
67Load build-abcl.lisp:
68
69    (load "build-abcl.lisp")
70
71Then do:
72
73    (build-abcl:build-abcl :clean t :full t)
74
75Wait for the build to finish and exit the host Lisp.
76
77Use abcl.bat on Windows or ./abcl on Unix to start ABCL.
78Note: abcl.bat and abcl contain absolute paths, so you'll need
79to edit them if you move things around after the build.
80
81In case of failure in the javac stage, you might try this:
82
83    (build-abcl:build-abcl :clean t :full t :batch nil)
84
85This invokes javac separately for each .java file, which avoids running
86into limitations on command line length (but is a lot slower).
87
88
89II. Ant-based build
90-------------------
91
92With Ant in your path, executing
93
94    ant -find build.xml abcl.wrapper
95
96from the directory containing this README file will create an
97executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).
98Use this wrapper to start the ABCL Java program.
99
100
101III. Netbeans-based build
102-------------------------
103
104One should be able to open the project as a project in Netbeans 6.x.
105
106
107BUGS
108====
109
110A lot of (renewed) energy has been spent to make ABCL a compliant
111and practically useable Common Lisp implementation.  Because of this,
112ABCL 0.0.11 now fails only 47 out of 21702 tests in the ANSI CL test
113suite.  Next to that, the fail count of the Maxima test suite has been
114reduced from over 1400 in 0.0.10 to little more than 600 in 0.0.11.
115
116ABCL's CLOS does not handle on-the-fly redefinition of classes
117correctly, and in any event is intolerably slow. There is no support
118for the long form of DEFINE-METHOD-COMBINATION, and certain other
119required CLOS features are also missing. Enough CLOS is there to run
120ASDF and CL-PPCRE, if you're in no hurry.
121
122There is no MOP worth mentioning.
123
124Since this is a early public release, there might be build
125problems as well as runtime bugs.
126
127Please report problems to the j-devel mailing list:
128
129    armedbear-j-devel@lists.sourceforge.net
130
131Have fun!
132
133On behalf of all ABCL development team and contributors,
134Erik Huelsmann
135October 18, 2008
Note: See TracBrowser for help on using the repository browser.