Merge branch 'improve-documentation' into 'master'
[atk.git] / README
blob4461bdeb3e425221b9df6db6d8c9f07d1f2f72da
1 ATK - The Accessibility Toolkit
2 ===============================
4 For more information about ATK and accessibility in GNOME, see:
6   https://wiki.gnome.org/Accessibility
8 Dependencies
9 ------------
11 ATK requires GLib >= 2.32. Information about GLib is available from:
13   https://www.gtk.org
15 Getting the source code
16 -----------------------
18 You can get the source code of each ATK release as a tarball:
20   https://download.gnome.org/sources/atk/
22 You can also clone the ATK master branch from GNOME repository:
24   https://git.gnome.org/browse/atk
26 Building
27 --------
29 You can use Meson and Ninja:
31     $ meson _build .
32     $ ninja -C _build
33     # ninja -C _build install
35 Tarball
36 -------
38 If you want a tarball with the ATK source code, you can also use
39 Meson:
41   $ meson _build .
42   $ ninja -C _build dist
44 How to report bugs
45 ------------------
47 Bugs should be reported to the GNOME bug tracking system:
49   http://bugzilla.gnome.org/enter_bug.cgi?product=atk
51 You will need to create an account for yourself.
53 You can also mail the mailing list gnome-accessibility-devel@gnome.org