# HG changeset patch
# User Guido Berhoerster <guido+rantaiwarna@berhoerster.name>
# Date 1422007684 -3600
# Node ID 0ec0edfcb752f38ab0e6120ccea8f64cfcc7ae00
# Parent  2ff9656aad52f9de8f82bc85e90b695579a2cf73
Improve README file

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

diff -r 2ff9656aad52 -r 0ec0edfcb752 README
--- a/README	Fri Jan 23 11:08:03 2015 +0100
+++ b/README	Fri Jan 23 11:08:04 2015 +0100
@@ -18,14 +18,73 @@
 Build Instructions
 ------------------
 
-rantaiwarna requires a POSIX:2004 compatible operating system, and needs GNU
-make, GNU or BSD install, the xsltproc tool from libxml2 and an implementation
-of the curses library compatible with X/Open CURSES Issue 4 to be installed.
-It can take advantage of advanced features of recent ncurses versions, in
-particular mouse support, but it also works with the native curses
-implementations of Solaris, NetBSD, and UnixWare.  It has been tested on Linux
-distributions, FreeBSD, Solaris and Illumos-derived distributions, UnixWare,
-and OpenServer.
+rantaiwarna requires a POSIX:2004 compatible operating system, it has been
+tested to work on Linux distributions, FreeBSD, NetBSD, Solaris and
+Illumos-derived distributions, and UnixWare.  The following tools and shared
+libraries are required to build rantaiwarna:
+
+- GNU make >= 3.81
+- GNU or BSD install
+- an implementation of the curses library compatible with X/Open CURSES
+  Issue 4 (rantaiwarna can take advantage of advanced features of recent
+  ncurses versions, in particular mouse support, but it also works with the
+  native curses implementations of at least Solaris, NetBSD, and UnixWare)
+
+Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
+
+Before building rantaiwarna 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+rantaiwarna@berhoerster.name>.
+
+Bug Reports
+-----------
+
+When sending bug reports, please always mention the exact version of
+rantaiwarna 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
 -------