r5268: *** empty log message ***

[cl-modlisp.git] / README

diff --git a/README b/README
index 439c8a1a7540e41a276794099bd4844a5e1df800..10fb3984696877cbd4854f13ec8338132df3b657 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,6 @@
 INTRODUCTION
 ------------
+
 This package provided the Lisp side of the interface to Marc
 Battyani's mod_lisp apache module (http://www.fractalconcept.com).
 
@@ -14,21 +15,48 @@ REREQUISITES
 
 1. Apache 1.3.x
 2. mod_lisp apache module (http://www.fractalconcept.com)
-3. cl-kmrcl library (http://files.b9.com/kmrcl)
-4. asdf 
+3. kmrcl library (http://files.b9.com/kmrcl)
+4. asdf (http://www.sf.net/projects/cclan)
+
+
+SUPPORTED PLATFORMS
+-------------------
+  Allegro v6.2
+  Lispworks v4.2
+  SBCL 0.8.1 with sb-thread (multitasking)
+  CMUCL 18e
+
 
 QUICKSTART
 ----------
 
-1. Install mod_lisp as described on the mod_lisp web site
+1. The easiest way to install is to use the Debian GNU/Linux operating
+system. Using the testing or unstable distributions, you can give the
+command:
+   apt-get install libapache-mod-lisp cl-modlisp cl-kmrcl
+
+If you are not using Debian, you will need to download and install
+mod_lisp, cl-modlisp, and cl-kmrcl manually.
+
 2. Add something like the below to httpd.conf and then restart apache
       LispServer 127.0.0.1 20123 "localhost"
       AddHandler lisp-handler .lsp
-3. Load cl-modlisp and cl-kmrcl
+
+3. Start your Lisp implementation and load cl-modlisp with 
+   (asdf:operate 'asdf:load-op 'modlisp) 
+
 4. Start the server with 
       (ml:modlisp-start :port 20123))
+
 5. Try some demostration pages
       lynx http://localhost/fixed.lsp
       lynx http://localhost/debug.lsp
+
 6. Shutdown the all cl-modlisp servers with
      (ml:modlisp-stop-all)
+
+
+USAGE
+-----
+
+Return to the demo.lisp file for some examples of using cl-modlisp.