summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2017-05-22 13:36:33 +0100
committerEmmanuele Bassi <ebassi@gnome.org>2017-05-22 13:44:20 +0100
commitaadb675641d7035bbd078b478ebc000cc2f5297d (patch)
treebccba79a7b15238323ee653847723af1697df72d
parent2f531e76cfe129d01dd8f9aeab1c9fc2d69f5bee (diff)
downloadatk-aadb675641d7035bbd078b478ebc000cc2f5297d.tar.gz
docs: Update the README
Mention Meson and Ninja, and clean up the text a little bit.
-rw-r--r--README55
1 files changed, 35 insertions, 20 deletions
diff --git a/README b/README
index c934aa5..92f19bd 100644
--- a/README
+++ b/README
@@ -1,44 +1,59 @@
-This directory contains the ATK library.
+ATK - The Accessibility Toolkit
+===============================
For more information about ATK and accessibility in GNOME, see:
- http://projects.gnome.org/accessibility
+
+ https://wiki.gnome.org/Accessibility
Dependencies
-============
+------------
+
+ATK requires GLib >= 2.32. Information about GLib is available from:
-ATK requires GLib >= 2.31.2. Information about GLib is available from
-http://www.gtk.org/.
+ https://www.gtk.org
Getting the source code
-=======================
+-----------------------
You can get the source code of each ATK release as a tarball:
-https://download.gnome.org/sources/atk/
+
+ https://download.gnome.org/sources/atk/
You can also clone the ATK master branch from GNOME repository:
-https://git.gnome.org/browse/atk
+
+ https://git.gnome.org/browse/atk
Building
-========
+--------
-To buid ATK from a release tarball, the usual is using autotool, as:
+To buid ATK from a release tarball you can use Autotools:
- $ ./configure
- $ make
- # make install
+ $ ./configure
+ $ make
+ # make install
-To build ATK from a Git clone, run the autogen.sh script instead of
-the configure one. Before running autogen.sh or configure, make sure
-you have libtool in your path.
+Alternatively, you can use Meson and Ninja:
-Note that autogen.sh runs configure for you. If you wish to pass
-options like --prefix=/usr to configure you can give those options
-to autogen.sh and they will be passed on to configure.
+ $ meson _build .
+ $ ninja -C _build
+ # ninja -C _build install
+
+To build ATK from a Git clone using Autotools, run the autogen.sh script
+instead of the configure one; before running autogen.sh or configure, make
+sure you have libtool in your path. If you use Meson, no changes are
+necessary.
+
+Note that autogen.sh runs the configure script for you. If you wish to pass
+options like --prefix=/usr to configure you can give those options to
+autogen.sh and they will be passed on to configure; if you wish to run
+autogen.sh without running the configure script, export the NOCONFIGURE
+environment variable.
How to report bugs
-==================
+------------------
Bugs should be reported to the GNOME bug tracking system:
+
http://bugzilla.gnome.org/enter_bug.cgi?product=atk
You will need to create an account for yourself.