README.md
1QAccessibilityClient
2====================
3
4This library is used when writing accessibility clients such as screen readers.
5It comes with some examples demonstrating the API. These small helpers may be useful when testing accessibility.
6One of them writes all accessibiliy interfaces an application provides as text output.
7The other, more advanced application shows a tree of objects and allows some interaction and exploration.
8
9Coding style: <http://techbase.kde.org/Policies/Kdelibs_Coding_Style>
10Generally this library follows <http://techbase.kde.org/Policies/Library_Code_Policy>
11
12Be aware that it is in an early stage of development right now so no compatibility is guaranteered.
13
14All public API is in:
15src/qaccessibilityclient
16
17The abstraction of DBus and related at-spi tools should go into
18src/atspi
19but not exported.
20
21You can generate documentation (see docs folder README).
22
23Using CMake with QAccessibilityClient
24-------------------------------------
25
26Do NOT write a Find*.cmake file! It just works the way it is (TM).
27
28Use:
29
30`find_package(QAccessibilityClient)`
31
32or, if you use feature logging:
33
34```cmake
35macro_optional_find_package(QAccessibilityClient)
36macro_log_feature(QAccessibilityClient_FOUND "qaccessibilityclient"
37 "KDE client-side accessibility library"
38 "https://projects.kde.org/libkdeaccessibilityclient"
39 FALSE "" "Required to enable accessibility features.")
40
41include_directories(${QACCESSIBILITYCLIENT_INCLUDE_DIR})
42target_link_libraries(targetname ${QACCESSIBILITYCLIENT_LIBRARY})
43```
44
45In your code `#include <qaccessibilityclient/accessibleobject.h>` etc.
46
47Creating releases
48-----------------
49
50There are no translations for QAccessibilityClient since the library does not contain any strings that should be shown to users.
51The examples are not translated, that could potentially be considered.
52Follow <https://community.kde.org/ReleasingSoftware>, skip the translation parts.
53
54* Set the project version in the top-level CMakeLists.txt, push.
55* `./tarme.rb --version 0.3.0 --origin stable libqaccessibilityclient`
56* tarme.rb has nice output that gives instructions.
57* `./tagme.rb --version 0.3.0 libqaccessibilityclient`
58* upload as directed
59* file sysadmin ticket
60* `./logme.rb` to create changelog
61* `./tagme --version 0.3.0` to push tag
62* blog/send mail
63