# HG changeset patch
# User Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
# Date 1422007095 -3600
# Node ID 82ac993fa76d21bc1b2e38119dc70233eec5bc96
# Parent  3457a401e685e278915a772af9e346635bf59add
Improve README file

Improve build instructions.
Add information on bug reporting.
Add contact information.

diff -r 3457a401e685 -r 82ac993fa76d README
--- a/README	Fri Jan 23 10:58:04 2015 +0100
+++ b/README	Fri Jan 23 10:58:15 2015 +0100
@@ -10,16 +10,74 @@
 Build Instructions
 ------------------
 
-XInhibit Applet requires GNU make, GNU gettext, GNU or BSD install, the
-xsltproc tool from libxml2 and the following shared libraries to be installed:
+xinhibit-applet requires a POSIX:2004 compatible operating system with an X11
+implementation which provides the XTEST extension at runtime, it has been
+tested to work on Linux distributions, FreeBSD, and Solaris and
+Illumos-derived distributions.  The following tools and shared libraries are
+required to build xinhibit-applet:
 
+- GNU make >= 3.81
+- GNU or BSD install
 - GLib version 2.12 or later
 - GTK+ version 2.18 or later
 - libunique
 - Xlib and the XTEST extension library
 
-Furthermore, it requires an X11 implementation which provides the XTEST
-extension at runtime as well.
+Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
+
+Before building xinhibit-applet check the commented macros in the Makefile for
+any macros you may need to override depending on the used toolchain and
+operating system.
+
+By default, all files will be installed under the "/usr/local" directory, a
+different installation path prefix can be set via the `prefix` macro.  In
+addition, a second path prefix can be specified via the `DESTDIR` macro which
+will be prepended to any path, incuding the `prefix` macro path prefix.  In
+contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
+prepended to paths during installation and not be used for constructing
+internal paths.
+
+The following instructions assume that `make` is GNU make, on some platforms
+it may be installed under a different name or a non-default path.  In order to
+start the build process run `make all`.  After a successful build, run `make
+install` to install the program, any associated data files and the
+documentation.
+
+Previously built binaries, object files, generated data files and
+documentation can be removed by running `make clean`, any additional,
+generated files which are not removed by the `clean` target can be removed by
+running `make clobber`.
+
+Contact
+-------
+
+Please send any feedback, translations or bug reports via email to
+<guido+xinhibit-applet@berhoerster.name>.
+
+Bug Reports
+-----------
+
+When sending bug reports, please always mention the exact version of
+xinhibit-applet with which the issue occurs as well as the version of the
+operating system you are using and make sure that you provide sufficient
+information to reproduce the issue and include any input, output, any error
+messages.
+
+In case of build issues, please also specify the implementations and versions
+of the tools and shared libraries used to build the program, in particular the
+compiler.
+
+In case of crashes, please generate a stack trace with a suitable debugger
+such as gdb, lldb, dbx, or debug after a crash has occurred either by
+examining the resulting core file or by running the program from the debugger
+and attach it to the bug report.  In order to generate a meaningful stack
+trace the program as well as any dynamically linked libraries need to be built
+with debugging information, see the documentation of the used compiler for the
+required compiler flags.  If any of the dynamically linked shared libraries do
+not contain debugging information, please either install debugging information
+for these libraries using mechanisms provided by your operating system or
+rebuild the libraries accordingly.  Please refer to the documentation of the
+debugger for detailed instructions on generating backtraces.
 
 License
 -------