Changeset 15335

Timestamp:

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

Author:

Mark Evenson

Message:

doc: further README revisions

File:

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

trunk/abcl/README

@@ -103 +103 @@
 'n glory await.
 
-SWANK
+
+SLIME
 -----
 
-One may easily start a swank listener via:
+For usage of ABCL with the [Superior Lisp Interaction Mode for
+Emacs][slime], one may easily start a Swank listener via:
 
     (require :asdf)
@@ -112 +114 @@
     (asdf:load-system :quicklisp-abcl)
     (ql:quickload :swank)
-    (swank:create-server :dont-close t) 
+    (swank:create-server :dont-close t)
+
+[slime]: https://common-lisp.net/project/slime/
 
 
@@ -171 +175 @@
 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
+linked SLIME `swank.asd` ASDF configuration
+<file:~/.config/common-lisp/source-registry.conf.d/> to connect a REPL
 to the NetBeans debug process.
 
@@ -180 +185 @@
 ----
 
-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.
+Armed Bear Common Lisp strives to be a conforming ANSI X3J13 Common
+Lisp implementation.  Any other behavior should be reported as a bug.
+
+ABCL has a [User Manual][manual] stating its conformance to the ANSI
+standard, providing a compliant and practical Common Lisp
+implementation.
+
+[manual]: https://abcl.org/releases/1.7.0/abcl-1.7.0.pdf
 
 
@@ -199 +207 @@
 Maxima's test suite runs without failures.
 
-ABCL comes with a test suite, see the output of `ant help.test` for
-more information.
+ABCL comes with a test suite.  Consult the output of `ant help.test`
+for more information.
 
 
@@ -207 +215 @@
 
 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>
+tests, and even patches to address them will be gladly accepted.
+
+Please report problems to the [development mailing list][mailing-list]
+or via opening an issue on either the [ABCL trac instance][trac] or
+[github][].
+
+[mailing-list]: https://mailman.common-lisp.net/pipermail/armedbear-devel/
+[github]: https://github.com/armedbear/abcl/issues
+[trac]: https://abcl.org/trac/
+
 
 Authors
-=======
+-------
 
 On behalf of all ABCL development team and contributors,