diff --git a/README.md b/README.md index 237b0c672bc3b9f90c7ab86e33454709d790e394..056d19111c697acbbc8038eced80dee0c1d3811e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,32 @@ -The Common Lisp Interface Manager -================================= +Common Lisp Interface Manager: The Original Series +================================================== Description ----------- -The contents of this repo are known to compile and work in -Allegro CL 8.2 and later. No work has been done to make it work on -other Common Lisps, even though there is considerable -conditionalization for many other CLs. +Common Lisp Interface Manager 2.0 based on the open source release by +Franz, Inc. TOS stands for The Original Series as a reference to Star +Trek: The Original Series. See the file LICENSE for information on the license for this source code. + +Running the software +-------------------- + +To manage dependencies `clim-tos` uses ASDF system definitions and +Quicklisp. To use the software clone its source code to +`~/quicklisp/local-projects` and call: + + (ql:quickload '(clim-tos clim-tos/clx-backend clim-tos/examples)) + (clim-demo:start-demo) + +Development status +------------------ + +Currently software has many problems which may result in application +crashes. It is not overly stable, but runs on SBCL and CCL with X11 +server backend. + +Project goals are to make it work reliably on conforming Common Lisp +implementations which feature Gray Streams and MOP extensions.