Protect against NULL pointer dereference

[platform/upstream/atk.git] / README

diff --git a/README b/README
index 24444ed..4461bde 100644 (file)
--- a/README
+++ b/README
@@ -1,35 +1,53 @@
-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.32. Information about GLib is available from:
+
+  https://www.gtk.org
+
+Getting the source code
+-----------------------
+
+You can get the source code of each ATK release as a tarball:
 
-In order to get CVS atk installed on your system, you need to have
-the most recent CVS version of glib installed as well.
+  https://download.gnome.org/sources/atk/
+
+You can also clone the ATK master branch from GNOME repository:
+
+  https://git.gnome.org/browse/atk
 
 Building
-========
+--------
+
+You can use Meson and Ninja:
+
+    $ meson _build .
+    $ ninja -C _build
+    # ninja -C _build install
+
+Tarball
+-------
 
-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:
+If you want a tarball with the ATK source code, you can also use
+Meson:
 
-        cvsroot/atk# ./autogen.sh
-  
-Basically this does the following for you:
+  $ meson _build .
+  $ ninja -C _build dist
 
-        cvsroot/atk# aclocal; automake; autoconf
+How to report bugs
+------------------
 
-        The above commands create the "configure" script.  Now you
-        can run the configure script in cvsroot/atk to create all
-        the Makefiles.
+Bugs should be reported to the GNOME bug tracking system:
 
-Before running autogen.sh or configure, make sure you have libtool
-in your path.
+  http://bugzilla.gnome.org/enter_bug.cgi?product=atk
 
-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.
+You will need to create an account for yourself.
 
+You can also mail the mailing list gnome-accessibility-devel@gnome.org