README

   1 D-Bus AT-SPI
   2 ------------
   3
   4 This version of at-spi is a major break from version 1.x.
   5 It has been completely rewritten to use D-Bus rather than
   6 ORBIT / CORBA for its transport protocol.
   7
   8 A page including instructions for testing, project status and
   9 TODO items is kept up to date at:
  10
  11         http://www.linuxfoundation.org/en/AT-SPI_on_D-Bus
  12
  13 The mailing list used for general questions is:
  14
  15         accessibility-atspi@lists.linux-foundation.org
  16
  17 For bug reports, feature requests, patches or enhancements please use
  18 the AT-SPI project on bugzilla.gnome.org. Use the at-spi2-atk component for
  19 bugs specific to this module.
  20
  21         http://bugzilla.gnome.org
  22
  23 A git repository with the latest development code is available at:
  24
  25         git://git.gnome.org/at-spi2-atk
  26
  27 Code in this repository depends on at-spi2-core resources. The
  28 at-spi2-core repository can be found at:
  29
  30         git://git.gnome.org/at-spi2-core
  31
  32 More information
  33 ----------------
  34
  35 The project was started with a D-Bus performance review
  36 the results of which are available on the GNOME wiki. Keep in
  37 mind that the D-Bus AT-SPI design documents on this page
  38 have not been kept up to date.
  39
  40         http://live.gnome.org/GAP/AtSpiDbusInvestigation/
  41
  42 Other sources of relevant information about AT-SPI and Accessibility
  43 include:
  44
  45         http://live.gnome.org/Accessibility
  46         http://www.sun.com/software/star/gnome/accessibility/architecture.xml
  47         http://accessibility.kde.org/developer/atk.php
  48         http://www.gnome.org/~billh/at-spi-idl/html/
  49
  50
  51
  52 Contents of this package
  53 ------------------------
  54
  55 This package includes libatk-bridge, a library that bridges ATK to the new
  56 D-Bus based AT-SPI, as well as a corresponding module for gtk+ 2.x. Gtk+ 3.x
  57 now links against libatk-bridge directly rather than requiring it to be loaded
  58 as a module.
  59
  60 These libraries depend on the at-spi2-core code that contains the daemon for
  61 registering applications, D-Bus helper libraries and the AT-SPI D-Bus specifications.
  62
  63 Tests
  64 -----
  65
  66 To run tests execute autogen.sh with '--with-tests=yes' parameter then
  67 after 'make', type 'make check'.
  68 Test result is available in tests/atk-test.log
  69
  70 Directory structure
  71 -------------------
  72
  73 The directories within this package are arranged as follows:
  74
  75     droute
  76
  77         Contains a framework for registering objects
  78         with a D-Bus connection and for routing messages to
  79         the implementing object.
  80
  81         Used by the ATK adaptor.
  82
  83     atk-adaptor
  84
  85         This directory contains code that bridges
  86         the at-spi to the GTK+ toolkit, and which is
  87         loaded at runtime by GTK+-based Gnome applications.
  88         The 'bridge' automatically registers GTK+-2.0
  89         applications with the accessibility registry,
  90         and relays UI events from application to registry.
  91         It is also responsible for servicing requests from
  92         the registry to register handlers for specific event
  93         types.
  94
  95     tests
  96
  97         Contains tests for atspi.
  98         More details in tests/README