[mcclim-cvs] CVS update: mcclim/Apps/Inspector/INSTALL

[Peter Scott]

Update of /project/mcclim/cvsroot/mcclim/Apps/Inspector
In directory common-lisp.net:/tmp/cvs-serv10645

Modified Files:
	INSTALL 
Log Message:
Fixed typos, changed clouseau::inspector to clouseau:inspector, added
Usage and Threading sections with examples to get people off to a
quick start, and put in a bigger example of inspecting a running
inspector.

Date: Tue Feb  8 23:23:12 2005
Author: pscott

Index: mcclim/Apps/Inspector/INSTALL
diff -u mcclim/Apps/Inspector/INSTALL:1.3 mcclim/Apps/Inspector/INSTALL:1.4
--- mcclim/Apps/Inspector/INSTALL:1.3	Tue Feb  8 23:14:01 2005
+++ mcclim/Apps/Inspector/INSTALL	Tue Feb  8 23:23:12 2005
@@ -1,3 +1,6 @@
+Quick start
+===========
+
 1. Start your Lisp system and make sure you have ASDF and McCLIM in
    your core file.
 
@@ -5,9 +8,50 @@
 
 3. Try something like:
 
-   (clouseau:inspector (clim:make-application-frame 'clouseau:inspector :obj 20))
+   (clouseau:inspector (clim:make-application-frame
+                        'clouseau:inspector :obj 20))
 
    in order to inspect the inspector pane.
 
-4. Lef-click on occurrences of objects or of "...".
+4. Left-click on occurrences of objects or of "...".
+
+
+Usage
+=====
+
+The inspector is invoked like this:
+
+(clouseau:inspector object)
+
+To get a feel for what the inspector can do, try these:
+
+(clouseau:inspector #'write-string)
+(clouseau:inspector #'documentation)
+(clouseau:inspector 'documentation)
+(clouseau:inspector '(1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16))
+
+Click on things. See what happens.
+
+
+Threading
+=========
+
+If you have a multithreaded Lisp implementation, you can start an
+inspector in a new process like this:
+
+(clouseau:inspector object :new-process t)
+
+For example, if you want to get really fancy and inspect a running
+inspector, this ugly hack should do the job:
 
+(let ((*print-length* 10)
+      (*print-level* 10)
+      inspected-inspector)
+  (setf inspected-inspector
+	(clim:make-application-frame 'clouseau::inspector
+				     :obj (clim:make-application-frame
+					   'clouseau::inspector :obj 20)))
+  (clim-sys:make-process #'(lambda ()
+			     (clim:run-frame-top-level inspected-inspector))
+			 :name "Inspector Clouseau (being inspected)")
+  (clouseau:inspector inspected-inspector :new-process t))
\ No newline at end of file