Changeset 15333


Ignore:
Timestamp:
06/27/20 05:36:37 (15 months ago)
Author:
Mark Evenson
Message:

doc: revisions to README

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/abcl/README

    r15312 r15333  
    1 Armed Bear Common Lisp README
    2 =============================
    3 
    4 GENERAL INFORMATION
    5 -------------------
    6 
    7 Armed Bear Common Lisp is a conforming implementation of ANSI Common
    8 Lisp that runs in a Java virtual machine.  It compiles Lisp code
    9 directly to Java byte code.
     1Armed Bear Common Lisp (ABCL) README
     2====================================
     3
     4Armed Bear Common Lisp is a conforming implementation of ANSI X2J13
     5Common Lisp that runs in a Java virtual machine.  It compiles Lisp
     6code directly to Java byte code for execution.
    107
    118
    129LICENSE
    13 =======
     10-------
    1411
    1512Armed Bear Common Lisp is distributed under the GNU General Public
     
    4340
    4441RUNNING FROM DOCKER
    45 ===================
     42-------------------
    4643
    4744With [Docker Engine][] installed one may execute:
     
    5451    illin:~/work/abcl$ docker run -it YOURID/abcl
    5552    Armed Bear Common Lisp 1.7.0
    56     Java 1.7.0_252 Oracle Corporation
     53    Java 11.0.7 AdoptOpenJDK   
    5754    OpenJDK 64-Bit Server VM
    5855    Low-level initialization completed in 0.295 seconds.
     
    7673
    7774RUNNING FROM BINARY RELEASE
    78 ===========================
     75---------------------------
    7976
    8077After you have downloaded a binary release from either [the
    8178distributed Maven POM graph][maven-abcl] or from
    8279[abcl.org][abcl.org-release] archive unpack it into its own
    83 directory. To run ABCL directly from this directory, make sure Java
    84 (Java 6, 7, 8, 11, 13, and 14 are supported by ABCL 1.7.0) is in your
    85 shell's path.
     80directory. To run ABCL directly from this directory, make sure the
     81Java executable (`java`) (Java 6, 7, 8, 11, 13, and 14 are supported
     82by ABCL 1.7.0) is in your shell's path.
    8683
    8784[maven-abcl]:          <https://mvnrepository.com/artifact/org.abcl/abcl/1.7.0>
     
    109106-----
    110107
    111 One may easily start a swank listener via
     108One may easily start a swank listener via:
    112109
    113110    (require :asdf)
    114111    (require :abcl-contrib)
    115     (asdf:load-system :quicklisp-abcl :force t)
    116     (ql:quickload :swank)                     
    117 
    118 
    119 BUILDING FROM SOURCE RELEASE
    120 ============================
     112    (asdf:load-system :quicklisp-abcl)
     113    (ql:quickload :swank)
     114    (swank:create-server :dont-close t)
     115
     116
     117Building From Source Release
     118----------------------------
    121119
    122120ABCL may be built from its source code by executing the build
     
    125123
    126124To build, one must have a Java 6, 7, 8, 11, 13 or 14 Java Development
    127 Kit (JDK) installed locally. Just the Java Runtime Environment (JRE)
    128 isn't enough, as you need the Java compiler ('javac') to compile the
    129 Java source of the ABCL implementation.
     125Kit (openjdk) installed locally. Just the Java Runtime Environment
     126(JRE) isn't enough, as you need the Java compiler ('javac') to compile
     127the Java source of the ABCL implementation.
    130128
    131129Download a binary distribution [Ant version 1.7.1 or greater][ant].
     
    157155    bash ci/create-abcl-properties.bash openjdk11
    158156
    159 Currently upported platforms are 'openjdk6', 'openjdk7', 'openjdk8',
     157Currently supported platforms are 'openjdk6', 'openjdk7', 'openjdk8',
    160158'openjdk11', 'openjdk13', and 'openjdk14'.
    161159
     
    166164Alternatively, one may install the [Netbeans visual integrated
    167165development environment][netbeans], which contains both the Java
    168 Development Kit as well as the Ant build tool.
     166Development Kit as well as the Ant build tool.  The source
     167distribution contains Netbeans-specific project artifacts under
     168<file:nbproject> for loading ABCL as a Netbeans project.
    169169
    170170With Netbeans, one should be able to open the ABCL directory as a
     
    177177
    178178
    179 BUGS
    180 ====
    181 
    182 ABCL is a conforming ANSI Common Lisp implementation.  Any other
    183 behavior should be reported as a bug.
    184 
    185 ABCL now has a manual stating its conformance to the ANSI standard,
     179Bugs
     180----
     181
     182Armed Bear Common Lisp is a conforming ANSI X3J13 Common Lisp
     183implementation.  Any other behavior should be reported as a bug.
     184
     185ABCL has a user manual stating its conformance to the ANSI standard,
    186186providing a compliant and practical Common Lisp implementation.
    187187
     
    202202more information.
    203203
    204 ### Deficiencies
    205 
    206 Many.  But patches to address issues mentioned above will be gladly
    207 accepted.
    208 
    209 CONTACT
     204
     205Support
     206-------
     207
     208ABCL has many deficiencies, both known and unknown.  Descriptions,
     209tests, and even patches to address will be gladly accepted.
     210
     211
     212Please report problems to the development mailing list:
     213
     214    <armedbear-devel@common-lisp.net>
     215
     216Authors
    210217=======
    211218
    212 Please report problems to the development mailing list:
    213 
    214     <armedbear-devel@common-lisp.net>
    215 
    216 AUTHORS
    217 =======
    218 
    219219On behalf of all ABCL development team and contributors,
    220220
    221221    Mark Evenson
    222     Erik Huelsmann
     222    Erik HÃŒlsmann
    223223    Rudolf Schlatte
    224224    Alessio Stalla
     
    232232    dmiles
    233233
     234    András Simon
     235    Peter Graves
     236
    234237Have fun!
    235238
Note: See TracChangeset for help on using the changeset viewer.