[mcclim-cvs] CVS mcclim

Thu Mar 23 16:37:54 UTC 2006

Update of /project/mcclim/cvsroot/mcclim
In directory clnet:/tmp/cvs-serv30838

Modified Files:
	INSTALL 
Removed Files:
	INSTALL.ASDF INSTALL.CLISP INSTALL.CMU INSTALL.OPENMCL 
	INSTALL.SBCL 
Log Message:
Updated instructions to refer only to asdf method

--- /project/mcclim/cvsroot/mcclim/INSTALL	2003/11/19 13:51:17	1.6
+++ /project/mcclim/cvsroot/mcclim/INSTALL	2006/03/23 16:37:54	1.7
@@ -1,64 +1,148 @@
-Install instructions for Franz Allegro Common Lisp
---------------------------------------------------
+Prerequisites:
+==============
 
-1. Start Lisp
+ASDF - The ASDF system definition facility. Many implementations come
+with it and (require :asdf) is all that is needed. If yours doesn't,
+see http://www.cliki.net/asdf.
 
-2. Load the system definition file:
 
-   (load "system")
 
-3. Compile and load the system:
+Installing McCLIM using mcclim.asd
+==================================
 
-   (compile-system :clim)
-   (compile-system :clim-clx)
-   (compile-system :clim-examples)
+To tell ASDF about the wherabouts of McCLIM and to compile it for the
+first time, perform these steps:
 
-4. Load the compiled system:
+ 1. Symlink mcclim.asd to a directory in your
+    asdf:*central-registry* list. E.g., for SBCL, that would be:
 
-   (load-system :clim)
-   (load-system :clim-clx)
-   (load-system :clim-examples)
+      $ ln -sf /path/to/mcclim.asd ~/.sbcl/systems/
+
+ 2. If you are using a Lisp implementation that requires a separate
+    CLX to be installed, do this now and symlink the clx's .asd file
+    to your asdf:*central-registry*, as above. If your
+    implementation's CLX doesn't come with a clx.asd file, you will
+    have to load CLX via (require :clx) or a similar mechanism
+    yourself.
+
+ 3. You need to install the spatial-trees library (available at
+    http://cliki.net/spatial-trees). The preferred method for that is
+    via asdf-install. see http://cliki.net/asdf-install for an
+    introduction to that method.
+    
+ 4. On your Lisp's REPL (with ASDF loaded), type
+
+     (asdf:oos 'asdf:load-op :mcclim)
+     ; compilation messages should zip past
+
+After step 4, McCLIM and the CLX backend should be loaded and
+you are good to go.
+
+When you restart your lisp image, you will need to perform step 4 to
+load McCLIM again.
+
+Installing mcclim.asd if you were using ASDF & system.lisp before
+=================================================================
+
+Make sure to remove all symlinks in your asdf:*central-registry* to
+system.lisp and replace them with symlinks to mcclim.asd. Keeping the
+old links around will break loading the McCLIM system in subtle ways.
+
+After replacing the symlinks, follow the "Installing McCLIM..."
+section above, beginning at step 1 - the symlink mcclim.asd itself is
+required, too.
+
+Writing a system that depends on McCLIM
+=======================================
+
+In an ASDF system that depends on a loaded CLIM, use the following
+code to declare a dependency on McCLIM:
+
+(defsystem :your-clim-using-system
+           :depends-on (:mcclim #| other dependencies |#)
+           :components (#| components |#)
+           )
+
+The dependency on the McCLIM system will also load a suitable display
+backend on implementations where it can determine one.
 
 Running the demos
------------------
+=================
+
+McCLIM comes with some interesting demo programs and applications:
+
+   address-book - The classic CLIM demo:
+   
+   (asdf:oos 'asdf:load :clim-examples)
+   (in-package :clim-demo)
+   (run-frame-top-level (make-application-frame 'address-book)
+
+   The Examples directory includes other demo programs that might be
+   of interest. Many of these are quite old and were written before
+   large parts of the CLIM specification were implemented; for good
+   examples of CLIM style it is best to look elsewhere.
+
+
+   clim-listener - a Lisp 'listener' or top-level loop with many
+   goodies for examining directories, CLOS classes, etc. Printed
+   results are mouse-sensitive and in supported implementations
+   (currently OpenMCL) can be used directly as arguments in Lisp expressions:
+
+   (asdf:oos 'asdf:load :clim-listener)
+   (clim-listener:run-listener)
+
+   
+   functional-geometry - Frank Buss' and Rainer Joswig's functional
+   geometry explorer, implmented on top of clim-listener:
+
+   (load "Apps/Functional-Geometry/functional-geometry.asd")
+   (asdf:oos 'asdf:load :functional-geometry)
+   (functional-geometry::run-functional-geometry)
+
+
+Installation Notes for Implementations
+======================================
+
+Notes about bugs or gotchas in specific Common Lisp implementations
+appear in the release notes found in the ReleaseNotes directory.
+
+Franz Allegro Common Lisp
+=========================
+
+McCLIM has been tested with the ANSI Common Lisp image alisp. It
+doesn't currently work in with "modern Lisp" but support is on the way.
+
 
-1. Run the calculator demo
+OpenMCL
+=======
 
-   (clim-demo::calculator)
+McCLIM has been tested with openmcl-1.0. It is recommended that you
+download CLX from ftp://clozure.com/pub/CLX.
 
-   This demo is self-explanatory.
-	
-   when you get tired of it, hit ^C in the Lisp listener.
+An experimental Cocoa backend for McCLIM, called Beagle, is included
+in Backends/beagle.
 
-2. Run the menu demo
 
-   (menutest::menutest)
+CLISP
+=====
 
-   This demo is self-explanatory.
-	
-   when you get tired of it, hit ^C in the Lisp listener.
+1. Get clisp-20041218 or newer. Build it with option --with-module=clx/mit-clx.
 
-3. Run the slider demo
+2. Get a copy of the ASDF package. Compile it:
+     $ clisp -c $ASDF/asdf.lisp
 
-   (clim-demo::colorslider)
+3. Start
+     $ clisp -K full -i $ASDF/asdf.fas
 
-   You should see three sliders on the left and a color area on the right. 
-   Use the three sliders to adjust RGB values to obtain a color.
+and continue as above.
 
-   when you get tired of it, hit ^C in the Lisp listener.
 
-4. A some of the demos should be run using the function clim-demo::run-test:
-   (clim-demo::run-test 'clim-demo::address-book)
-   (clim-demo::run-test 'goatee::goatee-test)
-   [N.B.: This advice is mostly obsolete. The usual way to start a
-   CLIM application is with e.g.,
-   (run-frame-top-level (make-application-frame 'clim-demo::address-book)
-   Any problems that result should be reported as bugs.]
+CMUCL
+=====
 
-Note:
+McCLIM has been tested with version 19.c.
 
-   Before running any McCLIM application, it may be necessary for you
-   to enable host based access to the X server. This can be
-   accomplished by executing the following command at a shell prompt:
+SBCL
+====
 
-	xhost localhost
+McCLIM has been tested with version 0.9.8 and later.


