Merge branch 'master' of https://github.com/gheber/kenzo

README.md

@@ -2,6 +2,8 @@
 
 [![GPLv3 Logo](http://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)
 
+[![Quicklisp badge](http://quickdocs.org/badge/kenzo.svg)](http://quickdocs.org/kenzo/)
+
 According to the title of its
 [handbook](http://www-fourier.ujf-grenoble.fr/~sergerar/Kenzo/Kenzo-doc.pdf),
 Kenzo is a "Symbolic Software for Effective Homology Computation" and
@@ -15,18 +17,12 @@ This version aims to update its infrastructure by providing the following:
 
 1. A simple regression test suite based on [FiveAM](http://common-lisp.net/project/fiveam/)
 2. Support for the great freely available Lisp compilers out there, including [CCL](http://ccl.clozure.com/), [ECL] (https://common-lisp.net/project/ecl/), [SBCL](http://www.sbcl.org/), etc.
-3. Installation via the [Quicklisp](http://www.quicklisp.org/beta/) library
+3. Installation via the [Quicklisp](http://www.quicklisp.org/beta/) library manager
-   manager
+4. Updated documentation and examples
-
-Items 1 and 2 are well underway. Item 3 is pending after Francis Sergeraert kindly
-agreed to license the software under [GPLv3](http://www.gnu.org/licenses/gpl-3.0.en.html).
 
 *!!! WARNING !!!*
 
-This is work in progress and there are several [issues](https://github.com/gheber/kenzo/issues).
+This is work in progress and there are several outstanding [issues](https://github.com/gheber/kenzo/issues).
-The entire code now compiles fine w/ CCL, ECL, SBCL, but that's just the first step. There are plenty
-of examples in [publications](http://www-fourier.ujf-grenoble.fr/~sergerar/Papers/) and scattered
-throughout the source. Many work (most?), some don't. *Let's get to work! ...*
 
 ## Getting up and running
 
@@ -47,18 +43,26 @@ Then in your Lisp (e.g., in ECL) type
 
 ### Quicklisp
 
-I'm a big fan and supporter of [Quicklisp](http://www.quicklisp.org/beta/), and use it for all my local projects.
+Assuming you have [Quicklisp](http://www.quicklisp.org/beta/), there isn't really much to say here:
-Assuming you've installed Quicklisp in `C:\home\quicklisp` or `/home/joeuser/quicklisp`, your *local projects directory* will be `C:\home\quicklisp\local-projects` or `/home/joeuser/quicklisp/local-projects`.
 
-Making Kenzo `quickload`-able is a piece of cake:
+```
+* (ql:quickload :kenzo)
+To load "kenzo":
+  Install 1 Quicklisp release:
+    kenzo
+; Fetching #<URL "http://beta.quicklisp.org/archive/kenzo/2015-08-04/kenzo-20150804-git.tgz">
+; 1835.57KB
+==================================================
+1,879,625 bytes in 1.48 seconds (1236.91KB/sec)
+; Loading "kenzo"
+[package cat].....................................
+..................................................
+..............................
+(:KENZO)
+*
+```
 
-1. Clone the Kenzo repository into your local projects directory, i.e., `C:\home\quicklisp\local-projects\kenzo` or `/home/joeuser/quicklisp/local-projects/kenzo`.
+Verify that you're good to go by loading and running the Kenzo regression test suite. For example, in an SBCL prompt you should see something like this:
-2. Tell Quicklisp about Kenzo by adding the following two lines to the `system-index.txt` file in the local projects directory:
-```
-  kenzo\kenzo.asd
-  kenzo\kenzo-test.asd
-```
-Verify that you're good to go by loading and running the Kenzo test suite. For example, in an `sbcl` prompt (I've tested this with SBCL 1.2.13 on Debian and Windows) you should see something like this:
 ```
 * (ql:quickload :kenzo-test)
 To load "kenzo-test":
@@ -74,15 +78,11 @@ Running test suite KENZO
  Running test L-CMPR ..........
  Running test S-CMPR .....
  ...
- Running test CDELTA
 ---done---
- Did 642 checks.
+ Did 786 checks.
-    Pass: 642 (100%)
+    Pass: 786 (100%)
     Skip: 0 ( 0%)
     Fail: 0 ( 0%)
 ```
 
 Similarly, you'd load Kenzo via `(ql:quickload :kenzo)`.
-
-
-[![GPLv3 Logo](http://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)