source: trunk/abcl/README @ 13709

Last change on this file since 13709 was 13709, checked in by Mark Evenson, 10 years ago

Spellcheck README

  • Property svn:eol-style set to native
File size: 6.5 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 Lisp code directly to
6Java byte code.
7
8
9LICENSE
10=======
11
12Armed Bear Common Lisp is distributed under the GNU General Public
13License with a classpath exception (see "Classpath Exception" 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
23** Classpath Exception
24
25As a special exception, the copyright holders of this software give
26you permission to link this software with independent modules to
27produce an executable, regardless of the license terms of these
28independent modules, and to copy and distribute the resulting
29executable under terms of your choice, provided that you also meet,
30for each linked independent module, the terms and conditions of the
31license of that module. An independent module is a module which is not
32derived from or based on this software. If you modify this software,
33you may extend this exception to your version of the software, but you
34are not obligated to do so. If you do not wish to do so, delete this
35exception statement from your version.
36
37
38RUNNING FROM BINARY RELEASE
39===========================
40
41After you have downloaded a binary release archive unpack it into its
42own directory. To run ABCL directly from this directory, make sure
43Java (version 1.5 or up) is in your shell's path. Then issue the
44following command:
45
46    cmd$ java -jar abcl.jar
47
48which should result in output like the following
49
50    Armed Bear Common Lisp 0.25.0
51    Java 1.6.0_21 Sun Microsystems Inc.
52    Java HotSpot(TM) Client VM
53    Low-level initialization completed in 0.3 seconds.
54    Startup completed in 2.294 seconds.
55    Type ":help" for a list of available commands.
56    CL-USER(1):
57
58
59BUILDING FROM SOURCE RELEASE
60============================
61
62There are three ways to build ABCL from the source release with the
63preferred (and most tested way) is to being to use the Ant build tool:
64
65* Use the Ant build tool for Java environments.
66
67* Use the NetBeans 6.x IDE to open ABCL as a project.
68
69* Bootstrap ABCL using a Common Lisp implementation. Supported
70  implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
71  CL, LispWorks or CLISP.
72
73In all cases you need a Java 5 or later JDK (JDK 1.5 and 1.6 have been
74tested).  Just the JRE isn't enough, as you need the Java compiler
75('javac') to compile the Java source of the ABCL implementation.
76
77Note that when deploying ABCL having JDK isn't a requirement for the
78installation site, just the equivalent JRE, as ABCL compiles directly
79to byte code, avoiding the need for the 'javac' compiler in deployment
80environments.
81
82
83Using Ant
84---------
85
86Download a binary distribution [Ant version 1.7.1 or greater][1].
87Unpack the files somewhere convenient, ensuring that the 'ant' (or
88'ant.bat' under Windows) executable is in your path and executable.
89
90[1]: http://ant.apache.org/bindownload.cgi
91
92Then simply executing
93
94    unix$ ant
95
96or
97    dos> ant.bat
98
99from the directory containing this README file will create an
100executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).  Use
101this wrapper to start ABCL.
102
103
104Using NetBeans
105--------------
106
107Obtain and install the [NetBeans IDE][2]. One should be able to open
108the ABCL directory as a project in the Netbeans 6.x application,
109whereupon the usual build, run, and debug targets as invoked in the
110GUI are available.
111
112[2]: http://netbeans.org/downloads/
113
114
115Building from Lisp
116------------------
117
118Building from a Lisp is the most venerable and untested way of
119building ABCL.  It produces a "non-standard" version of the
120distribution that doesn't share build instructions with the previous
121two methods, but it still may be of interest to those who absolutely
122don't want to know anything about Java.
123
124First, copy the file 'customizations.lisp.in' to 'customization.lisp',
125in the directory containing this README file, editing to suit your
126situation, paying attention to the comments in the file.  The critical
127step is to have Lisp special variable '*JDK*' point to the root of the
128Java Development Kit.  Underneath the directory referenced by the
129value of '*JDK*' there should be an executable Java compiler in
130'bin/javac' ('bin/java.exe' under Windows).
131
132Then, one may either use the 'build-from-lisp.sh' shell script or load
133the necessary files into your Lisp image by hand.
134
135** Using the 'build-from-lisp.sh' script
136
137Under UNIX-like systems, you may simply invoke the
138'build-from-lisp.sh' script as './build-from-lisp.sh
139<lisp-of-choice>', e.g.
140
141    unix$ ./build-from-lisp.sh sbcl
142
143After a successful build, you may use 'abcl' ('abcl.bat' on Windows)
144to start ABCL.  Note that this wrappers contain absolute paths, so
145you'll need to edit them if you move things around after the build.
146
147If you're developing on ABCL, you may want to use
148
149    unix$ ./build-from-lisp.sh <implementation> --clean=nil
150
151to not do a full rebuild.
152
153In case of failure in the javac stage, you might try this:
154
155    unix$ ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil
156
157This invokes javac separately for each .java file, which avoids running
158into limitations on command line length (but is a lot slower).
159
160** Building from another Lisp by hand
161
162There is also an ASDF definition in 'abcl.asd' for the BUILD-ABCL
163which can be used to load the necessary Lisp definitions, after which
164
165    CL-USER> (build-abcl:build-abcl :clean t :full t)
166
167will build ABCL.  If ASDF isn't present, simply LOAD the
168'customizations.lisp' and 'build-abcl.lisp' files to achieve the same
169effect as loading the ASDF definition.
170
171
172BUGS
173====
174
175ABCL is a conforming ANSI Common Lisp implementation.  Any other
176behavior should be reported as a bug.
177
178ABCL now has a manual stating its conformance to the ANSI standard,
179providing a compliant and practical Common Lisp implementation.
180Because of this,
181
182
183### Tests
184
185ABCL 1.0.0 now fails only 18 out of 21708 total tests in the ANSI CL
186test suite (derived from the tests originally written for GCL).
187
188Maxima's test suite runs without failures.
189
190### Deficiencies
191
192The MOP implementation is incomplete.
193
194Patches to address any of the issues mentioned above will
195be gladly accepted.
196
197Please report problems to the development mailing list:
198
199    <armedbear-devel@common-lisp.net>
200
201Have fun!
202
203On behalf of all ABCL development team and contributors,
204Erik Huelsmann
205Mark Evenson
206Alessio Stalla
207Ville Voutilaninen
208
209October 2011
210
Note: See TracBrowser for help on using the repository browser.