README 6.31 KB
Newer Older
1 2 3
Armed Bear Common Lisp README
=============================

4
GENERAL INFORMATION
5
-------------------
6

7 8 9
Armed Bear Common Lisp is a conforming implementation of ANSI Common
Lisp that runs in a Java virtual machine.  It compiles Lisp code
directly to Java byte code.
10

11

12 13 14 15
LICENSE
=======

Armed Bear Common Lisp is distributed under the GNU General Public
16
License with a classpath exception (see "Classpath Exception" below).
17

18 19
A copy of GNU General Public License (GPLv2) is included in this
distribution, in <file:COPYING>.
20

21
We have modfied our GPLv2 license section 13 to read:
22

23 24 25 26
     13. Linking this library statically or dynamically with other
     modules is making a combined work based on this library. Thus, the
     terms and conditions of the GNU General Public License cover the
     whole combination.
27

28 29 30 31 32 33 34 35 36 37 38 39 40 41
     The following paragraph details the "classpath exception" which ABCL
     allows as an exception to the statement about linking libraries.

     As a special exception, the copyright holders of this software give
     you permission to link this software with independent modules to
     produce an executable, regardless of the license terms of these
     independent modules, and to copy and distribute the resulting
     executable under terms of your choice, provided that you also meet,
     for each linked independent module, the terms and conditions of the
     license of that module. An independent module is a module which is
     not derived from or based on this software. If you modify this
     software, you may extend this exception to your version of the
     software, but you are not obligated to do so. If you do not wish to
     do so, delete this exception statement from your version.
42

43

44 45 46
RUNNING FROM DOCKER
===================

47
With [Docker Engine][] installed one may execute:
48

49 50 51 52 53
    docker run -it easye/abcl

to get

    illin:~/work/abcl$ docker run -it easye/abcl
54
    Armed Bear Common Lisp 1.6.0-dev
55 56 57 58 59 60 61 62
    Java 1.8.0_111 Oracle Corporation
    OpenJDK 64-Bit Server VM
    Low-level initialization completed in 0.295 seconds.
    Startup completed in 1.425 seconds.
    Type ":help" for a list of available commands.
    CL-USER(1): 23
    23

63 64 65

[Docker Engine]: https://www.docker.com/products/docker-engine

66

67 68
Building a Docker Image With Modifications
------------------------------------------
69

70
Get the source (see below); make yer mods; use the Dockerfile to build.
71

72 73
        docker build -t YOURID/abcl .
        docker run -it YOURID/abcl 
74

75
See <file:Dockerfile> for the build instructions.
76

77

78 79 80
RUNNING FROM BINARY RELEASE
===========================

81 82 83 84 85
After you have downloaded a binary release from either [the
distributed Maven POM graph][maven-abcl] or from
[abcl.org][abcl.org-release] archive unpack it into its own
directory. To run ABCL directly from this directory, make sure Java
(version 1.6 or up) is in your shell's path.
86

87
[maven-abcl]:          <https://mvnrepository.com/artifact/org.abcl/abcl/1.5.0>
88 89
[maven-abcl-contrib]:  <https://mvnrepository.com/artifact/org.abcl/abcl-contrib/1.5.0>
[abcl.org-release]:    <http://abcl.org/releases/1.5.0/>
90

91
To start ABCL, simply issue the following command:
92

93
    cmd$ java -jar abcl.jar
94

95
which should result in output like the following
96

97
    Armed Bear Common Lisp 1.6.0-dev
98
    Java 1.8.0_131 Oracle Corporation
99 100 101
    Java HotSpot(TM) 64-Bit Server VM
    Low-level initialization completed in 0.324 seconds.
    Startup completed in 1.892 seconds.
102 103
    Type ":help" for a list of available commands.
    CL-USER(1):
104

105 106
Yer now at the interactive ABCL "Read Eval Print Loop" (REPL): hacks
'n glory await.
107

108

109 110
BUILDING FROM SOURCE RELEASE
============================
111

112 113 114
ABCL may be built from its source code by executing the build
instructions <file:build.xml> expressed by the venerable Apache Ant
tool.
115

116 117 118 119
To build, one must have a Java 6, 7 or 8 Java Development Kit (JDK)
installed locally. Just the Java Runtime Environment (JRE) isn't
enough, as you need the Java compiler ('javac') to compile the Java
source of the ABCL implementation.
120

121
Download a binary distribution [Ant version 1.7.1 or greater][ant].
122 123 124
Unpack the files somewhere convenient, ensuring that the 'ant' (or
'ant.bat' under Windows) executable is in your path and executable.

125
[ant]: http://ant.apache.org/bindownload.cgi
126

127
Then simply executing 
128

129
    cmd$ ant
130

131 132 133
from the directory containing the <file:build.xml> instructions will
create an executable wrapper ('abcl' under UNIX, 'abcl.bat' under
Windows).  Use this wrapper to start ABCL.
134

135 136 137 138 139
The build may be customized by copying <file:abcl.properties.in> to
<file:abcl.properties>, which will cause Ant to attempt to build
incrementally as well as optimizing the runtime for a contemporary
64bit desktop/server machine running Java 8.  The file may be edited
for further customization.
140 141


142 143
Using NetBeans
--------------
144

145 146 147
Alternatively, one may install the [Netbeans visual integrated
development environment][netbeans], which contains both the Java
Development Kit as well as the Ant build tool.
148

149 150 151 152 153
With Netbeans, one should be able to open the ABCL directory as a
project whereupon the usual build, run, and debug targets as invoked
in the GUI are available.  Use the 'slime' config with a suitably
linked 'swank.asd' in '~/.asdf-install-dir/systems/' to connect a REPL
to the NetBeans debug process.
154

155
[netbeans]: http://netbeans.org/downloads/
156

157

158 159 160
BUGS
====

161 162 163
ABCL is a conforming ANSI Common Lisp implementation.  Any other
behavior should be reported as a bug.

164 165
ABCL now has a manual stating its conformance to the ANSI standard,
providing a compliant and practical Common Lisp implementation.
166 167


168 169
Tests
-----
170

171
ABCL 1.5.0 now fails 48 out of 21708 total tests in the [revised and
172 173 174 175
expanded ANSI CL test suite][ansi-test] (derived from the tests
originally written for GCL).

[ansi-test]: git+https://gitlab.common-lisp.net/ansi-test/ansi-test.git
176 177

Maxima's test suite runs without failures.
178

179 180
ABCL comes with a test suite, see the output of `ant help.test` for
more information.
181

182
### Deficiencies
183

184
Many.  But patches to address issues mentioned above will be gladly
185
accepted.
186

187 188
CONTACT
=======
189

190
Please report problems to the development mailing list:
191

192
    <armedbear-devel@common-lisp.net>
193 194 195

Have fun!

196 197
AUTHORS
=======
198

199
On behalf of all ABCL development team and contributors,
200

201 202
    Mark Evenson
    Erik Huelsmann
203
    Rudolf Schlatte
204
    Alessio Stalla
205
    Ville Voutilainen
206

207
    alan
208
    olof ferada
209 210
    pipping
    slyrus
211 212
    vibhu
    dmiles
213

214
June 2017
215

216