X-Git-Url: https://git.distorted.org.uk/~mdw/clg/blobdiff_plain/b56b4e4a61ad9bc2ca52157a5704d0cd0ba68f52..8f49b7a10a9717890ca98dff2b01799b80ce2761:/README

diff --git a/README b/README
index 565e2b7..337eff7 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 This package contains Common Lisp bindings to GTK+ v2.x. It currently
-only works with CMUCL 19 and SBCL 0.9, but ports to other CL
+works with CMUCL 19, SBCL 0.9 and CLISP. Ports to other CL
 implementations may be added later.
 
 
@@ -16,7 +16,7 @@ Build instructions
 
 1. If you are using a version of SBCL without native callback support
    you need to upgrade or add third party callback code. The following 
-   instructions of how to add third party callback support, are borrowed 
+   instructions of how to add callback support, are borrowed
    from the Common Music installation guide:
 
    1. Download Thomas Burdick's Alien Function package¹ and restore it 
@@ -38,24 +38,14 @@ Build instructions
 
 2. Set up paths to match your system:
 
-   - Add a logical-pathname-translation to the clg root directory in
-     ~/.cmucl-init.lisp, ~/.sbclrc or some other startup file, like
-     this:
-
-       (setf
-         (logical-pathname-translations "clg")
-         '(("**;*.*.*" "/home/espen/src/clg/**/")))
-
    - Set the correct pkg-config search path if your Gtk+ installation
      is in an unusual place, by adding it to the PKG_CONFIG_PATH
      environment variable before starting lisp.
 
    - Make sure ASDF finds the system definition files:
        
-       (push 
-	#+sbcl(truename #p"clg:systems") 
-	#+cmu(concatenate 'string (unix-namestring #p"clg:systems") "/")
-	asdf:*central-registry*)
+       (push "/path/to/clg/systems/" asdf:*central-registry*)
+
 
      When checking out of CVS also do the following:
      $ cd <clg toplevel>
@@ -83,6 +73,9 @@ Build instructions
 
      #+sbcl(setq swank:*communication-style* :fd-handler)
 
+   CLISP needs to be started with the option '-ansi' for clg to
+   compile and load.
+
 
 4. If everything worked, try (load "hello-world") to see a small
    window pop up, and then run testgtk.lisp in the example directory.
@@ -98,6 +91,11 @@ so it is also wise to check the source code.
 
 - library prefixes are stripped from all symbols
 
+- object properties should be available as virtual slots. A lot of 
+  "missing" properties are manually defined as slots. Slots may be read
+  only or write only, but there later type are generally only
+  defined automatically through introspection
+
 - the get/set part are removed from regular accessors, but retained
   in functions which set or retrieve multiple values
 
@@ -110,9 +108,6 @@ so it is also wise to check the source code.
 
 - there are no gtk_*_new functions, use MAKE-INSTANCE to create widgets
 
-- all object properties are available as virtual slots. A lot of
-  "missing" properties are manually defined as slots
-
 - use CHILD-PROPERTY-VALUE or automatically defined accessors to
   access child properties
 
@@ -120,6 +115,35 @@ so it is also wise to check the source code.
 
 - the only function used to connect signals is SIGNAL-CONNECT
 
+- some additional initargs to make-instance:
+
+  - gtk:container
+
+    child -- adds a child to a container widget. This argument could
+    be a widget or a list who's first element is a widget and the rest
+    child properties. Multiple :child initargs may be specified
+
+    children -- list of children to be added
+
+    child-args -- default child properties used when adding children (during
+    construction only)
+
+    show-children -- automatically make children (and grandchildren)
+    visible. May be overridden in a child by explicit specifying :visible or
+    another :show-children
+
+
+  - gtk:button
+
+    stock -- equivalent to ":label stock :use-stock t :use-underline t"
+
+
+  - gtk:dialog
+
+    button -- button specification applied to dialog-add-button. Multiple
+    :button initargs may be specified
+
+    buttons -- list of button specifications