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         https://git.gnome.org/browse/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         https://git.gnome.org/browse/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         https://wiki.gnome.org/Accessibility/Documentation/GNOME2/ATSPI2-Investigation
  41
  42 Other sources of relevant information about AT-SPI and Accessibility
  43 include:
  44
  45         https://wiki.gnome.org/Accessibility
  46         https://accessibility.kde.org/developer/atk.php
  47         https://people.gnome.org/~billh/at-spi-idl/html/
  48
  49
  50
  51 Contents of this package
  52 ------------------------
  53
  54 This package includes libatk-bridge, a library that bridges ATK to the new
  55 D-Bus based AT-SPI, as well as a corresponding module for gtk+ 2.x. Gtk+ 3.x
  56 now links against libatk-bridge directly rather than requiring it to be loaded
  57 as a module.
  58
  59 These libraries depend on the at-spi2-core code that contains the daemon for
  60 registering applications, D-Bus helper libraries and the AT-SPI D-Bus specifications.
  61
  62 Building this package
  63 ---------------------
  64
  65 In order to build at-spi2-atk you will need:
  66
  67  - Python 3.5
  68  - Meson
  69  - Ninja
  70
  71 Additionally, you will need the development files for:
  72
  73  - libdbus
  74  - GLib
  75  - GTK+ 3.x
  76  - ATK
  77  - AT-SPI
  78
  79 To build and install this package, you will typically need to run `meson` to
  80 configure the build process, and Ninja to run the compilation and installation
  81 instructions:
  82
  83     # Configure the build and initialize the build directory
  84     meson _build .
  85
  86     # Enter the build directory
  87     cd _build
  88
  89     # Build the project
  90     ninja
  91
  92     # Install the project
  93     sudo ninja install
  94
  95 Tests
  96 -----
  97
  98 To run the test suite, use `meson test` from the build directory.
  99
 100 Directory structure
 101 -------------------
 102
 103 The directories within this package are arranged as follows:
 104
 105     droute
 106
 107         Contains a framework for registering objects
 108         with a D-Bus connection and for routing messages to
 109         the implementing object.
 110
 111         Used by the ATK adaptor.
 112
 113     atk-adaptor
 114
 115         This directory contains code that bridges
 116         the at-spi to the GTK+ toolkit, and which is
 117         loaded at runtime by GTK+-based Gnome applications.
 118         The 'bridge' automatically registers GTK+-2.0
 119         applications with the accessibility registry,
 120         and relays UI events from application to registry.
 121         It is also responsible for servicing requests from
 122         the registry to register handlers for specific event
 123         types.
 124
 125     tests
 126
 127         Contains tests for atspi.
 128         More details in tests/README