source: trunk/abcl/README @ 14930

Last change on this file since 14930 was 14930, checked in by Mark Evenson, 5 years ago

docker: instructions for running ABCL in Docker

TODO: fix up the swank autostart sequence, but other than that getting
to a repl is as easy as

docker run easye/abcl /usr/local/bin/abcl

Happy hacking!

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