Changeset 15333

Timestamp:

06/27/20 05:36:37 (3 years ago)

Author:

Mark Evenson

Message:

doc: revisions to README

File:

• trunk/abcl/README (modified) (11 diffs)

trunk/abcl/README

@@ -1 @@
-Armed Bear Common Lisp README
-=============================
-
-GENERAL INFORMATION
--------------------
-
-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.
+Armed Bear Common Lisp (ABCL) README
+====================================
+
+Armed Bear Common Lisp is a conforming implementation of ANSI X2J13
+Common Lisp that runs in a Java virtual machine.  It compiles Lisp
+code directly to Java byte code for execution.
 
 
 LICENSE
-=======
+-------
 
 Armed Bear Common Lisp is distributed under the GNU General Public
@@ -43 +40 @@
 
 RUNNING FROM DOCKER
-===================
+-------------------
 
 With [Docker Engine][] installed one may execute:
@@ -54 +51 @@
     illin:~/work/abcl$ docker run -it YOURID/abcl
     Armed Bear Common Lisp 1.7.0
-    Java 1.7.0_252 Oracle Corporation
+    Java 11.0.7 AdoptOpenJDK    
     OpenJDK 64-Bit Server VM
     Low-level initialization completed in 0.295 seconds.
@@ -76 +73 @@
 
 RUNNING FROM BINARY RELEASE
-===========================
+---------------------------
 
 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
-(Java 6, 7, 8, 11, 13, and 14 are supported by ABCL 1.7.0) is in your
-shell's path.
+directory. To run ABCL directly from this directory, make sure the
+Java executable (`java`) (Java 6, 7, 8, 11, 13, and 14 are supported
+by ABCL 1.7.0) is in your shell's path.
 
 [maven-abcl]:          <https://mvnrepository.com/artifact/org.abcl/abcl/1.7.0>
@@ -109 +106 @@
 -----
 
-One may easily start a swank listener via
+One may easily start a swank listener via:
 
     (require :asdf)
     (require :abcl-contrib)
-    (asdf:load-system :quicklisp-abcl :force t)
-    (ql:quickload :swank)                     
-
-
-BUILDING FROM SOURCE RELEASE
-============================
+    (asdf:load-system :quicklisp-abcl)
+    (ql:quickload :swank)
+    (swank:create-server :dont-close t) 
+
+
+Building From Source Release
+----------------------------
 
 ABCL may be built from its source code by executing the build
@@ -125 +123 @@
 
 To build, one must have a Java 6, 7, 8, 11, 13 or 14 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.
+Kit (openjdk) 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.
 
 Download a binary distribution [Ant version 1.7.1 or greater][ant].
@@ -157 +155 @@
     bash ci/create-abcl-properties.bash openjdk11
 
-Currently upported platforms are 'openjdk6', 'openjdk7', 'openjdk8',
+Currently supported platforms are 'openjdk6', 'openjdk7', 'openjdk8',
 'openjdk11', 'openjdk13', and 'openjdk14'.
 
@@ -166 +164 @@
 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.
+Development Kit as well as the Ant build tool.  The source
+distribution contains Netbeans-specific project artifacts under
+<file:nbproject> for loading ABCL as a Netbeans project.
 
 With Netbeans, one should be able to open the ABCL directory as a
@@ -177 +177 @@
 
 
-BUGS
-====
-
-ABCL is a conforming ANSI Common Lisp implementation.  Any other
-behavior should be reported as a bug.
-
-ABCL now has a manual stating its conformance to the ANSI standard,
+Bugs
+----
+
+Armed Bear Common Lisp is a conforming ANSI X3J13 Common Lisp
+implementation.  Any other behavior should be reported as a bug.
+
+ABCL has a user manual stating its conformance to the ANSI standard,
 providing a compliant and practical Common Lisp implementation.
 
@@ -202 +202 @@
 more information.
 
-### Deficiencies
-
-Many.  But patches to address issues mentioned above will be gladly
-accepted.
-
-CONTACT
+
+Support
+-------
+
+ABCL has many deficiencies, both known and unknown.  Descriptions,
+tests, and even patches to address will be gladly accepted.
+
+
+Please report problems to the development mailing list:
+
+    <armedbear-devel@common-lisp.net>
+
+Authors
 =======
 
-Please report problems to the development mailing list:
-
-    <armedbear-devel@common-lisp.net>
-
-AUTHORS
-=======
-
 On behalf of all ABCL development team and contributors,
 
     Mark Evenson
-    Erik Huelsmann
+    Erik HÃŒlsmann
     Rudolf Schlatte
     Alessio Stalla
@@ -232 +232 @@
     dmiles
 
+    András Simon
+    Peter Graves
+
 Have fun!