Update README.md

This commit is contained in:
Gerd Heber 2015-07-13 19:33:44 -05:00
parent 682b7ad2f8
commit ec5ad4d359

View File

@ -12,19 +12,18 @@ at http://www-fourier.ujf-grenoble.fr/~sergerar/Kenzo/ .
This version aims to update its infrastructure by providing the following: 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/) 1. A simple regression test suite based on [FiveAM](http://common-lisp.net/project/fiveam/)
2. Support for [SBCL](http://www.sbcl.org/) 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
Items 1 and 2 are well underway. Item 3 is on hold, because there's apparently no license Items 1 and 2 are well underway. Item 3 is pending after Francis Sergeraert kindly
attached to Kenzo. I have made several attempts to contact the author(s), but never gotten agreed to license the software under [GPLv3](http://www.gnu.org/licenses/gpl-3.0.en.html).
a response.
*!!! WARNING !!!* *!!! WARNING !!!*
This is work in progress. The entire code now compiles fine w/ SBCL, but that's This is work in progress and there are several [issues](https://github.com/gheber/kenzo/issues).
just the first step. There are plenty of examples in The entire code now compiles fine w/ CCL, ECL, SBCL, but that's just the first step. There are plenty
[publications](http://www-fourier.ujf-grenoble.fr/~sergerar/Papers/) and scattered 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! ...* throughout the source. Many work (most?), some don't. *Let's get to work! ...*
## Getting up and running ## Getting up and running
@ -38,7 +37,7 @@ the source, e.g. by creating a link to this directory at
~/.local/share/common-lisp/source/ ~/.local/share/common-lisp/source/
Then in your Lisp (e.g. in ECL) type Then in your Lisp (e.g., in ECL) type
```lisp ```lisp
(require :asdf) (require :asdf)
(require :kenzo) (require :kenzo)
@ -57,7 +56,7 @@ Making Kenzo `quickload`-able is a piece of cake:
kenzo\kenzo.asd kenzo\kenzo.asd
kenzo\kenzo-test.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.12 on Debian and Windows) you should see something like this: 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) * (ql:quickload :kenzo-test)
To load "kenzo-test": To load "kenzo-test":
@ -66,10 +65,7 @@ To load "kenzo-test":
; Loading "kenzo-test" ; Loading "kenzo-test"
. .
(:KENZO-TEST) (:KENZO-TEST)
* (in-package :fiveam) * (fiveam:run!)
#<PACKAGE "IT.BESE.FIVEAM">
* (run!)
Running test suite KENZO Running test suite KENZO
Running test F-CMPR .......... Running test F-CMPR ..........
@ -78,8 +74,8 @@ Running test suite KENZO
... ...
Running test CDELTA Running test CDELTA
---done--- ---done---
Did 329 checks. Did 642 checks.
Pass: 329 (100%) Pass: 642 (100%)
Skip: 0 ( 0%) Skip: 0 ( 0%)
Fail: 0 ( 0%) Fail: 0 ( 0%)
``` ```