X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=README;h=10fb3984696877cbd4854f13ec8338132df3b657;hb=f0aefda1754a567f9a42fce25c5a9b05cc1ab4f4;hp=724d175712f322ee8a335c58f8e08132fb699f44;hpb=118ee93d69e2b09d12eb317f6db3fbda113be82f;p=cl-modlisp.git

diff --git a/README b/README
index 724d175..10fb398 100644
--- a/README
+++ b/README
@@ -1,4 +1,62 @@
-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. 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. 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. 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.