From 418d832048337821d7def2a62cefa81124219aa4 Mon Sep 17 00:00:00 2001 From: Gerd Heber Date: Tue, 4 Aug 2015 20:46:59 -0500 Subject: [PATCH 1/4] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6117d29..61b8f09 100644 --- a/README.md +++ b/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 From 0b08258c7aa45bf6b58580eb4e35fc8694da86a4 Mon Sep 17 00:00:00 2001 From: Gerd Heber Date: Tue, 4 Aug 2015 20:56:08 -0500 Subject: [PATCH 2/4] Update README.md --- README.md | 42 ++++++++++++++++++++---------------------- 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 61b8f09..7a46895 100644 --- a/README.md +++ b/README.md @@ -20,15 +20,9 @@ This version aims to update its infrastructure by providing the following: 3. Installation via the [Quicklisp](http://www.quicklisp.org/beta/) library manager -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). -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 @@ -49,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'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`. +Assuming you have [Quicklisp](http://www.quicklisp.org/beta/), there isn't really much to say here: -Making Kenzo `quickload`-able is a piece of cake: +``` +* (ql:quickload :kenzo) +To load "kenzo": + Install 1 Quicklisp release: + kenzo +; Fetching # +; 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`. -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: +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: ``` * (ql:quickload :kenzo-test) To load "kenzo-test": @@ -76,15 +78,11 @@ Running test suite KENZO Running test L-CMPR .......... Running test S-CMPR ..... ... - Running test CDELTA ---done--- - Did 642 checks. - Pass: 642 (100%) + Did 786 checks. + 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) From 8ce5dba831acb2582391ff1de98f6f703533e3df Mon Sep 17 00:00:00 2001 From: Gerd Heber Date: Tue, 4 Aug 2015 21:05:07 -0500 Subject: [PATCH 3/4] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7a46895..445174d 100644 --- a/README.md +++ b/README.md @@ -17,12 +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 - manager +3. Installation via the [Quicklisp](http://www.quicklisp.org/beta/) library manager +4. Updated documentation and examples *!!! 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). ## Getting up and running From 9e4adb575e1b94d3b9d2f76dc917af366ed49b2e Mon Sep 17 00:00:00 2001 From: Gerd Heber Date: Tue, 4 Aug 2015 21:06:21 -0500 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 445174d..2d41ddc 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ To load "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: +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: ``` * (ql:quickload :kenzo-test) To load "kenzo-test":