X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fat-spi2-atk.git;a=blobdiff_plain;f=README;h=21e57d0e9395b83ff08957b20af5c61ed09cef14;hp=f7bc782a57a64e977baed8c3a06d2b7ef428d219;hb=d1e52eb847dcabf7a2be07dbd71cfcb4e0805306;hpb=ff143bfb6c3ca9e1a7362bd7f9c7c5eba31eb135

diff --git a/README b/README
index f7bc782..21e57d0 100644
--- a/README
+++ b/README
@@ -1,45 +1,106 @@
-README
+D-Bus AT-SPI
+------------
 
-at-spi version 1.9.0
-
-This version of at-spi requires atk 1.17.0 or later.
-
-This version of at-spi is a MAJOR break from previous versions.
+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.
 
-*** Welcome to the Gnome Accessibility Project! ***
+A page including instructions for testing, project status and
+TODO items is kept up to date at:
+
+        http://www.linuxfoundation.org/en/AT-SPI_on_D-Bus
+
+The mailing list used for general questions is:
+
+        accessibility-atspi@lists.linux-foundation.org
+
+For bug reports, feature requests, patches or enhancements please use
+bugzilla. The freedesktop project name is at-spi2.
+
+        http://bugs.freedesktop.org
+
+A git repository with the latest development code is available at:
+
+        git://anongit.freedesktop.org/git/at-spi2/att-spi2-atk
+
+Code in this repository depends on at-spi2-core resources. The
+at-spi2-core repository can be found at:
+
+        git://anongit.freedesktop.org/git/at-spi2/att-spi2-core
+
+More information
+----------------
+
+The project was started with a D-Bus performance review
+the results of which are available on the GNOME wiki. Keep in
+mind that the D-Bus AT-SPI design documents on this page
+have not been kept up to date.
+
+        http://live.gnome.org/GAP/AtSpiDbusInvestigation/
+
+Other sources of relevant information about AT-SPI and Accessibility
+include:
+
+        http://live.gnome.org/Accessibility
+        http://www.sun.com/software/star/gnome/accessibility/architecture.xml
+        http://accessibility.kde.org/developer/atk.php
+        http://www.gnome.org/~billh/at-spi-idl/html/
 
-If you have not already done so, please visit 
 
-http://developer.gnome.org/projects/gap 
 
-for background information on accessibility, the Gnome 
-Accessibility Project, mailing list info, and project status.
+Contents of this package
+------------------------
 
-Contents of this package ==================================
+This package includes a gtk-module that bridges ATK to the new D-Bus based AT-SPI
+as well as 'C' and Python client libraries.
+
+These libraries depend on the at-spi2-core code that contains the daemon for
+registering applications, D-Bus helper libraries and te AT-SPI D-Bus specifications.
+
+Directory structure
+-------------------
 
 The directories within this package are arranged as follows:
 
-    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".
-
-    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.
+    common
+
+        Contains 'C' types derived from the D-Bus
+        protocol specification. These types are used by 
+        the ATK adaptor and 'Cspi'.
+        Structures are mainly related to events.
+
+    droute
+
+        Contains a framework for registering objects
+        with a D-Bus connection and for routing messages to
+        the implementing object.
+
+        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.
+
+    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.
+
+    pyatspi
+
+        The python client library for accessing D-Bus accessibility.