source: trunk/abcl/README @ 13165

Last change on this file since 13165 was 13165, checked in by ehuelsmann, 11 years ago

Update README.

  • Property svn:eol-style set to native
File size: 6.3 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 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
43
44    cmd$ java -jar abcl.jar
45
46which should result in output like the following
47
48    Armed Bear Common Lisp 0.25.0
49    Java 1.6.0_21 Sun Microsystems Inc.
50    Java HotSpot(TM) Client VM
51    Low-level initialization completed in 0.3 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
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:
62
63* Use the Ant build tool for Java environments.
64
65* Use the Netbeans 6.x IDE to open ABCL as a project.
66
67* Bootstrap ABCL using a Common Lisp implementation. Supported
68  implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
69  CL, LispWorks or CLISP.
70
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.
74
75When deploying ABCL, the JDK isn't a requirement for the installation
76site: ABCL compiles directly to byte code, avoiding the need for the
77'javac' compiler in deployment environments.
78
79
80Using Ant
81---------
82
83Download a binary distribution [Ant version 1.7.1 or greater][1].
84Unpack the files somewhere convenient, ensuring that the 'ant' (or
85'ant.bat' under Windows) executable is in your path and executable.
86
87[1]: http://ant.apache.org/bindownload.cgi
88
89Then simply executing
90
91    unix$  ant
92
93or
94    cmd$ ant.bat
95
96from the directory containing this README file will create an
97executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).  Use
98this wrapper to start ABCL.
99
100
101Using NetBeans
102--------------
103
104Obtain and install the [Netbeans IDE][2]. One should be able to open
105the ABCL directory as a project in the Netbeans 6.x application,
106whereupon the usual build, run, and debug targets as invoked in the
107GUI are available.
108
109[2]: http://netbeans.org/downloads/
110
111
112Building from Lisp
113------------------
114
115Building from a Lisp is the most venerable and untested way of
116building ABCL.  It produces a "non-standard" version of the
117distribution that doesn't share build instructions with the previous
118two methods, but it still may be of interest to those who absolutely
119don't want to know anything about Java.
120
121First, copy the file 'customizations.lisp.in' to customization.lisp',
122in the directory containing this README file, editing to suit your
123situation, paying attention to the comments in the file.  The critical
124step is to have Lisp special variable '*JDK*' point to the root of the
125Java Development Kit.  Underneath the directory referenced by the
126value of '*JDK*' there should be an exectuable Java compiler in
127'bin/javac' ('bin/java.exe' under Windows).
128
129Then, one may either use the 'build-from-lisp.sh' shell script or load
130the necessary files into your Lisp image by hand.
131
132** Using the 'build-from-lisp.sh' script
133
134Under UNIX-like systems, you may simply invoke the
135'build-from-lisp.sh' script as './build-from-lisp.sh
136<lisp-of-choice>', e.g.
137
138    unix$ ./build-from-lisp.sh sbcl
139
140After a successful build, you may use 'abcl.bat' on Windows or 'abcl'
141on Unix to start ABCL.  Note that this wrappers contain absolute
142paths, so you'll need to edit them if you move things around after the
143build.
144
145If you're developing on ABCL, you may want to use
146
147    unix$ ./build-from-lisp.sh <implementation> --clean=nil
148
149to not do a full rebuild.
150
151In case of failure in the javac stage, you might try this:
152
153    unix$ ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil
154
155This invokes javac separately for each .java file, which avoids running
156into limitations on command line length (but is a lot slower).
157
158** Building from another Lisp by hand
159
160There is also an ASDF definition in 'abcl.asd' for the BUILD-ABCL
161which can be used to load the necessary Lisp definitions, after which
162
163    CL-USER> (build-abcl:build-abcl :clean t :full t)
164
165will build ABCL.  If ASDF isn't present, simply LOAD the
166'customizations.lisp' and 'build-abcl.lisp' files to achieve the same
167effect as loading the ASDF definition.
168
169
170BUGS
171====
172
173A lot of (renewed) energy has been spent to make ABCL a compliant
174and practically useable Common Lisp implementation.  Because of this,
175ABCL 0.25.0 now fails only 28 out of 21702 tests in the ANSI CL test
176suite.  In addition, Maxima's test suite runs without failures now
177and ABCL's CLOS complete, with the exception of the long form of
178DEFINE-METHOD-COMBINATION - which is an ongoing effort.
179
180There is no MOP worth mentioning.
181
182Patches to address any of the issues mentioned above will
183be gladly accepted.
184
185Please report problems to the development mailing list:
186
187    armedbear-devel@common-lisp.net
188
189Have fun!
190
191On behalf of all ABCL development team and contributors,
192Erik Huelsmann
193January 20, 2011
Note: See TracBrowser for help on using the repository browser.