[libwnck] [misc] Update README



commit 9c021619e2e4625a20bbdee683e762ae1159d9d6
Author: Vincent Untz <vuntz gnome org>
Date:   Wed Sep 8 19:23:40 2010 +0200

    [misc] Update README
    
    Nothing new, but make sure this is up-to-date.
    
    Also tweak a bit autogen.sh and Makefile.am to make them look similar in
    all my modules.

 Makefile.am |    8 ++++----
 README      |   50 +++++++++++++++++++++++++++++++++++++++++++-------
 autogen.sh  |    2 +-
 3 files changed, 48 insertions(+), 12 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index a4f0271..fd7af7f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -5,13 +5,13 @@ ACLOCAL_AMFLAGS = -I m4
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libwnck-1.0.pc
 
-DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-introspection
-
 EXTRA_DIST = \
+	HACKING				\
 	MAINTAINERS			\
 	libwnck-1.0.pc.in		\
-	libwnck-1.0-uninstalled.pc.in	\
-	HACKING
+	libwnck-1.0-uninstalled.pc.in
+
+DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-introspection
 
 MAINTAINERCLEANFILES = \
 	$(srcdir)/INSTALL \
diff --git a/README b/README
index 9621c11..b51b7a1 100644
--- a/README
+++ b/README
@@ -1,12 +1,48 @@
+libwnck
+=======
+
 libwnck is Window Navigator Construction Kit, i.e. a library to use
 for writing pagers and taskslists and stuff.  
 
-libwnck isn't supported in the devel platform, which means OS vendors won't
-guarantee the API/ABI long-term, but authors of open source apps
+libwnck is not supported in the devel platform, which means OS vendors
+won't guarantee the API/ABI long-term, but authors of open source apps
 should feel free to use libwnck as users can always recompile against
-a new version.  (And the API/ABI has historically changed very little,
-I'm not changing it gratuitously or without soname increments.)
+a new version. The API/ABI has historically changed very little: we are
+not changing it gratuitously or without soname increments.
+
+Documentation for the API is available with gtk-doc. The code
+implementing the tasklist or pager widgets (tasklist.c and pager.c) can
+also be used as sample code.
+
+You may download updates to the package from:
+
+   http://download.gnome.org/sources/libwnck/
+
+To discuss libwnck, you may use the desktop-devel-list mailing list:
+
+  http://mail.gnome.org/mailman/listinfo/desktop-devel-list
+
+
+Installation
+============
+
+See the file 'INSTALL'. If you are not using a released version of
+libwnck (for example, if you checked out the code from git), you first
+need to run './autogen.sh'.
+
+
+How to report bugs
+==================
+
+Bugs should be reported to the GNOME bug tracking system:
+
+   https://bugzilla.gnome.org/ (product libwnck)
+
+You will need to create an account for yourself.
+
+Please read the following page on how to prepare a useful bug report:
+
+   https://bugzilla.gnome.org/page.cgi?id=bug-writing.html
 
-There are API docs in the source code, and API documentation can be
-generated by configuring --enable-gtk-doc. Also tasklist.c and pager.c make
-good sample code.
+Please read the HACKING file for information on where to send changes or
+bugfixes for this package.
diff --git a/autogen.sh b/autogen.sh
index ef00210..6d156e7 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -9,7 +9,7 @@ REQUIRED_AUTOMAKE_VERSION=1.9
 REQUIRED_M4MACROS=introspection.m4
 
 (test -f $srcdir/configure.ac \
-  && test -f $srcdir/libwnck/libwnck.h) || {
+  && test -f $srcdir/$PKG_NAME.doap) || {
     echo -n "**Error**: Directory "\`$srcdir\'" does not look like the"
     echo " top-level $PKG_NAME directory"
     exit 1



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]