r5266: *** empty log message ***

[cl-modlisp.git] / README

diff --git a/README b/README
index 724d175712f322ee8a335c58f8e08132fb699f44..439c8a1a7540e41a276794099bd4844a5e1df800 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,34 @@
-This is a a thin-layer providing the Lisp side of the
-interface to Marc Battyani's mod_lisp apache module
-(http://www.fractalconcept.com).
+INTRODUCTION
+------------
+This package provided the Lisp side of the interface to Marc
+Battyani's mod_lisp apache module (http://www.fractalconcept.com).
 
+cl-modlisp has cross-implementation support for sockets and
+multiprocessing.  This packages maintains a list of listener processes
+and sockets as well as worker processes and sockets. cl-modlisp will
+cleanly close sockets and kill processes when a listener is stopped.
+
+
+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 
+
+QUICKSTART
+----------
+
+1. Install mod_lisp as described on the mod_lisp web site
+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
+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)