Added first pass at a collection interface (completely untested)
[platform/core/uifw/at-spi2-atk.git] / README
diff --git a/README b/README
index 4d6be25..c46a596 100644 (file)
--- a/README
+++ b/README
@@ -1,46 +1,72 @@
-This is the initial CVS checkin of the Gnome Accessibility Project's
-Assistive Technology Service Provider Interface.
+at-spi version 1.9.0
 
-At the moment it does not include IDL for all of the SPI, but it does
-provide a prototype implementation of the core of the out-of-process
-accessibility service, the 'registry'.
+This version of at-spi requires atk 1.17.0 or later.
 
-Accessible applications will register with this registry service (via OAF)
-and adaptive/assistive technologies will register with the service as
-well, to indicate their interest in receiving UI events.  ATs can also use
-the registry's services programmatically to query accessible applications.
+This version of at-spi is a MAJOR break from previous versions.
+It has been completely rewritten to use D-Bus rather than
+ORBIT / CORBA for its transport protocol.
 
+If you have not already done so, please visit 
 
-Running the test programs: ============================
+http://developer.gnome.org/projects/gap 
 
-At the moment the only clients and 'apps' are the test at client and
-test app in the 'tests' subdirectory.
+for background information on accessibility, the Gnome 
+Accessibility Project, mailing list info, and project status.
 
-If you have a working ORBit2/OAF installation you can run the tests after
-adding the registryd directory to OAF's directory list with oaf-sysconf,
-or by installing Accessibility_Registry.oaf in your 'oafinfo' directory.
+Contents of this package ==================================
 
-You can then run './at' and './app' from the 'test' directory, to see
-'app' register as an application, and 'at' as a listening client.
-OAF should take care of the job of bootstrapping the registry daemon
-('registryd') for you.
+The directories within this package are arranged as follows:
 
-At the moment app and at deregistration are broken, so you are advised
-to kill the registry daemon if you exit either 'at' or 'app' instances.
-You may run as many instances of each as you like, concurrently - you
-may find it useful to do so in separate terminal windows.
+    idl : This directory contains the interface definitions
+       (in Interface Definition Language) for the
+       accessibility support interfaces exposed by
+       the AT central registry, accessible applications,
+       and UI components.
 
+       This is possibly historic. The idl formed the basis
+       for the XML protocol definitions now located
+       in the directory "xml".
 
-'at' connects to the registry as an event listener, then queries the
-service for the number of virtual desktops (currently always 0 or 1),
-and queries each desktop for the accessible applications it is running.
-It then prints out the name of each such application (as reported by the
-application's accessibility interfaces), and then waits to receive events.
+    xml : This directory contains XML documents describing
+       the D-Bus protocol in a subset of Telepathy XML.
 
-'app' connects to the registry as an application, then dispatches an
-event which the registry should relay to all registered listeners.
-Thus instances of 'app' run after 'at' should cause the 'at' instances
-to receive events.
+    tools : Miscellaneous tools. Mostly for converting protocol
+       XML into D-Bus introspection, 'C' types and documentation.
 
+    droute : Contains a framework for registering objects
+       with a D-Bus connection and for routing messages to
+       the implementing object.
 
--Bill
+       Used by the ATK adaptor.
+
+    dbind : Library to ease making D-Bus method calls, contains
+       marshalling code to convert function arguments
+       and a provided D-Bus signature into a D-Bus message.
+       
+       Used by cspi.
+
+    spi-common : Contains 'C' types derived from the D-Bus
+       protocol specification. These types are used by 
+       both the registry daemon and the ATK adaptor.
+       Structures are mainly related to events.
+
+    registryd : This directory contains code specific to the
+       central accessibility registry, and the registry
+       executable is built in this directory.
+
+    atk-adaptor : This directory contains code that bridges 
+       the at-spi to the GTK+ toolkit, and which is
+       loaded at runtime by GTK+-based Gnome applications.
+       The 'bridge' automatically registers GTK+-2.0
+       applications with the accessibility registry, 
+       and relays UI events from application to registry.
+       It is also responsible for servicing requests from
+       the registry to register handlers for specific event
+       types.
+
+    cspi : The client (AT) side interface - 'C' bindings.
+
+    registryd : The registry daemon code. The registry daemon
+       keeps a register of accessible applications and presents
+       this to clients (ATs).
+       It is also responsible for delivering device events.