source: branches/1.0.x/abcl/README @ 13734

Last change on this file since 13734 was 13734, checked in by Mark Evenson, 9 years ago

Update README version for 1.0.1

  • 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 1.0.1
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, 1.6 and 1.7 have
74been tested).  Just the JRE isn't enough, as you need the Java
75compiler ('javac') to compile the Java source of the ABCL
76implementation.
77
78Note that when deploying ABCL having JDK isn't a requirement for the
79installation site, just the equivalent JRE, as ABCL compiles directly
80to byte code, avoiding the need for the 'javac' compiler in deployment
81environments.
82
83
84Using Ant
85---------
86
87Download a binary distribution [Ant version 1.7.1 or greater][1].
88Unpack the files somewhere convenient, ensuring that the 'ant' (or
89'ant.bat' under Windows) executable is in your path and executable.
90
91[1]: http://ant.apache.org/bindownload.cgi
92
93Then simply executing
94
95    unix$ ant
96
97or
98    dos> ant.bat
99
100from the directory containing this README file will create an
101executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).  Use
102this wrapper to start ABCL.
103
104
105Using NetBeans
106--------------
107
108Obtain and install the [NetBeans IDE][2]. One should be able to open
109the ABCL directory as a project in the Netbeans 6.x application,
110whereupon the usual build, run, and debug targets as invoked in the
111GUI are available.
112
113[2]: http://netbeans.org/downloads/
114
115
116Building from Lisp
117------------------
118
119Building from a Lisp is the most venerable and untested way of
120building ABCL.  It produces a "non-standard" version of the
121distribution that doesn't share build instructions with the previous
122two methods, but it still may be of interest to those who absolutely
123don't want to know anything about Java.
124
125First, copy the file 'customizations.lisp.in' to 'customization.lisp',
126in the directory containing this README file, editing to suit your
127situation, paying attention to the comments in the file.  The critical
128step is to have Lisp special variable '*JDK*' point to the root of the
129Java Development Kit.  Underneath the directory referenced by the
130value of '*JDK*' there should be an executable Java compiler in
131'bin/javac' ('bin/java.exe' under Windows).
132
133Then, one may either use the 'build-from-lisp.sh' shell script or load
134the necessary files into your Lisp image by hand.
135
136** Using the 'build-from-lisp.sh' script
137
138Under UNIX-like systems, you may simply invoke the
139'build-from-lisp.sh' script as './build-from-lisp.sh
140<lisp-of-choice>', e.g.
141
142    unix$ ./build-from-lisp.sh sbcl
143
144After a successful build, you may use 'abcl' ('abcl.bat' on Windows)
145to start ABCL.  Note that this wrappers contain absolute paths, so
146you'll need to edit them if you move things around after the build.
147
148If you're developing on ABCL, you may want to use
149
150    unix$ ./build-from-lisp.sh <implementation> --clean=nil
151
152to not do a full rebuild.
153
154In case of failure in the javac stage, you might try this:
155
156    unix$ ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil
157
158This invokes javac separately for each .java file, which avoids running
159into limitations on command line length (but is a lot slower).
160
161** Building from another Lisp by hand
162
163There is also an ASDF definition in 'abcl.asd' for the BUILD-ABCL
164which can be used to load the necessary Lisp definitions, after which
165
166    CL-USER> (build-abcl:build-abcl :clean t :full t)
167
168will build ABCL.  If ASDF isn't present, simply LOAD the
169'customizations.lisp' and 'build-abcl.lisp' files to achieve the same
170effect as loading the ASDF definition.
171
172
173BUGS
174====
175
176ABCL is a conforming ANSI Common Lisp implementation.  Any other
177behavior should be reported as a bug.
178
179ABCL now has a manual stating its conformance to the ANSI standard,
180providing a compliant and practical Common Lisp implementation.
181Because of this,
182
183
184### Tests
185
186ABCL 1.0.1 now fails only 18 out of 21708 total tests in the ANSI CL
187test suite (derived from the tests orginally written for GCL).
188
189Maxima's test suite runs without failures.
190
191### Deficiencies
192
193The MOP implementation is incomplete.
194
195Patches to address any of the issues mentioned above will
196be gladly accepted.
197
198Please report problems to the development mailing list:
199
200    <armedbear-devel@common-lisp.net>
201
202Have fun!
203
204On behalf of all ABCL development team and contributors,
205Erik Huelsmann
206Mark Evenson
207Alessio Stalla
208Ville Voutilaninen
209
210Janurary 2012
211
Note: See TracBrowser for help on using the repository browser.