# HG changeset patch
# User Guido Berhoerster <guido+relmon@berhoerster.name>
# Date 1422007536 -3600
# Node ID a886a736c766f138caeef470f088a59ee6aa1706
# Parent  a3a833118423f0f1129b77a09d024ac533402e31
Improve README file

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

diff -r a3a833118423 -r a886a736c766 README
--- a/README	Fri Jan 23 11:05:34 2015 +0100
+++ b/README	Fri Jan 23 11:05:36 2015 +0100
@@ -17,12 +17,59 @@
 different formats, including formatted text, machine-parseable text, and HTML,
 optionally with the history of releases in Atom feed fromat.
 
-Requirements
-------------
+Build Instructions
+------------------
+
+relmon requires Tcl 8.5 or later, tcllib, tls, and tdom and has been tested to
+work on Linux distributions and FreeBSD.  The following tools are required to
+build relmon:
+
+- GNU make >= 3.81
+- GNU or BSD install
+
+Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
+
+Before building relmon check the commented macros in the Makefile for any
+macros you may need to override depending on the used tools 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.
 
-relmon requires GNU make, GNU or BSD install, the xsltproc tool from libxml2,
-Tcl 8.5 or later, tcllib, tls, and tdom. It has been tested on Linux
-distributions and FreeBSD.
+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 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+relmon@berhoerster.name>.
+
+Bug Reports
+-----------
+
+When sending bug reports, please always mention the exact version of relmon
+with which the issue occurs as well as the version of Tcl and 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 used tools.
+
+In case of crashes, please include the stack trace that was generated by the
+Tcl interpreter in the bug report.
 
 License
 -------