source: trunk/abcl/README @ 14178

Last change on this file since 14178 was 14044, checked in by Mark Evenson, 8 years ago

README: Correct Authors to spelling in Manual.

Sorry Ville!

Rudi --> Rudolf

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