diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..6aa155a --- /dev/null +++ b/README.md @@ -0,0 +1,121 @@ +D-Bus AT-SPI +------------ + +This version of at-spi is a major break from version 1.x. +It has been completely rewritten to use D-Bus rather than +ORBIT / CORBA for its transport protocol. + +An outdated page including instructions for testing, project status and +TODO items is at: + + https://wiki.linuxfoundation.org/accessibility/atk/at-spi/at-spi_on_d-bus + +The mailing list used for general questions is: + + https://lists.linuxfoundation.org/mailman/listinfo/accessibility-atspi + +For bug reports, feature requests, patches or enhancements please use: + + https://gitlab.gnome.org/GNOME/at-spi2-atk/ + +A git repository with the latest development code is available at: + + https://gitlab.gnome.org/GNOME/at-spi2-atk/ + +Code in this repository depends on at-spi2-core resources. The +at-spi2-core repository can be found at: + + https://gitlab.gnome.org/GNOME/at-spi2-atk/ + +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. + + https://wiki.gnome.org/Accessibility/Documentation/GNOME2/ATSPI2-Investigation + +Other sources of relevant information about AT-SPI and Accessibility +include: + + https://wiki.gnome.org/Accessibility + https://community.kde.org/Accessibility + + +Contents of this package +------------------------ + +This package includes libatk-bridge, a library that bridges ATK to the new +D-Bus based AT-SPI, as well as a corresponding module for gtk+ 2.x. Gtk+ 3.x +now links against libatk-bridge directly rather than requiring it to be loaded +as a module. + +These libraries depend on the at-spi2-core code that contains the daemon for +registering applications, D-Bus helper libraries and the AT-SPI D-Bus specifications. + +Building this package +--------------------- + +In order to build at-spi2-atk you will need: + + - Python 3.5 + - Meson + - Ninja + +Additionally, you will need the development files for: + + - libdbus + - GLib + - GTK+ 3.x + - ATK + - AT-SPI + +To build and install this package, you will typically need to run `meson` to +configure the build process, and Ninja to run the compilation and installation +instructions: + + # Configure the build and initialize the build directory + meson _build . + + # Enter the build directory + cd _build + + # Build the project + ninja + + # Install the project + sudo ninja install + +Tests +----- + +To run the test suite, use `meson test` from the build directory. + +Directory structure +------------------- + +The directories within this package are arranged as follows: + + 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. + + 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. + + tests + + Contains tests for atspi. + More details in tests/README |