source: trunk/abcl/README @ 14869

Last change on this file since 14869 was 14869, checked in by mevenson, 15 months ago

doc: proofreading; add release locations; ANSI compileit results

Failing 46 ANSI tests now, which indicates that a little triage before
releasing abcl-1.4.0 would be a good idea.

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