Release 2.25.2
[platform/upstream/atk.git] / README
diff --git a/README b/README
index 742a2f3..92f19bd 100644 (file)
--- a/README
+++ b/README
@@ -1,53 +1,61 @@
-This directory contains the ATK library.
+ATK - The Accessibility Toolkit
+===============================
 
 For more information about ATK and accessibility in GNOME, see:
- http://developer.gnome.org/projects/gap
+
+  https://wiki.gnome.org/Accessibility
 
 Dependencies
-============
+------------
 
-ATK requires GLib-2.0.0 or better. Information about GLib
-is available from http://www.gtk.org/.
+ATK requires GLib >= 2.32. Information about GLib is available from:
 
-Building
-========
+  https://www.gtk.org
+
+Getting the source code
+-----------------------
+
+You can get the source code of each ATK release as a tarball:
 
-To configure ATK, run the ./configure script, then 'make'; and 
-'make install'. If you are installing into a location where you don't have
-write permission, you'll have to become root before running 
-'make install'.
+  https://download.gnome.org/sources/atk/
 
-General information about building ATK and related libraries can
-be found at:
+You can also clone the ATK master branch from GNOME repository:
 
-  http://developer.gnome.org/doc/API/2.0/gtk/gtk-building.html
+  https://git.gnome.org/browse/atk
 
-To compile a CVS version of atk on your system, you will need to take
-several steps to setup the tree for compilation.  You can do all these
-steps at once by running:
+Building
+--------
+
+To buid ATK from a release tarball you can use Autotools:
 
-        cvsroot/atk# ./autogen.sh
-  
-Basically this does the following for you:
+    $ ./configure
+    $ make
+    # make install
 
-        cvsroot/atk# aclocal; automake; autoconf
+Alternatively, you can use Meson and Ninja:
 
-        The above commands create the "configure" script.  Now you
-        can run the configure script in cvsroot/atk to create all
-        the Makefiles.
+    $ meson _build .
+    $ ninja -C _build
+    # ninja -C _build install
 
-Before running autogen.sh or configure, make sure you have libtool
-in your path.
+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 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.
+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
 
-Bugs should be reported to the GNOME bug tracking system.
-(http://bugzilla.gnome.org, product atk.) You will need to create an
-account for yourself.
+You will need to create an account for yourself.
 
 You can also mail the mailing list gnome-accessibility-devel@gnome.org