projects/relmon

changeset 8:a886a736c766

Improve README file

Add build instructions.
Add information on bug reporting.
Add contact information.
author Guido Berhoerster <guido+relmon@berhoerster.name>
date Fri Jan 23 11:05:36 2015 +0100 (2015-01-23)
parents a3a833118423
children 4ecf1408f04f
files README
line diff
     1.1 --- a/README	Fri Jan 23 11:05:34 2015 +0100
     1.2 +++ b/README	Fri Jan 23 11:05:36 2015 +0100
     1.3 @@ -17,12 +17,59 @@
     1.4  different formats, including formatted text, machine-parseable text, and HTML,
     1.5  optionally with the history of releases in Atom feed fromat.
     1.6  
     1.7 -Requirements
     1.8 -------------
     1.9 +Build Instructions
    1.10 +------------------
    1.11  
    1.12 -relmon requires GNU make, GNU or BSD install, the xsltproc tool from libxml2,
    1.13 -Tcl 8.5 or later, tcllib, tls, and tdom. It has been tested on Linux
    1.14 -distributions and FreeBSD.
    1.15 +relmon requires Tcl 8.5 or later, tcllib, tls, and tdom and has been tested to
    1.16 +work on Linux distributions and FreeBSD.  The following tools are required to
    1.17 +build relmon:
    1.18 +
    1.19 +- GNU make >= 3.81
    1.20 +- GNU or BSD install
    1.21 +
    1.22 +Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
    1.23 +
    1.24 +Before building relmon check the commented macros in the Makefile for any
    1.25 +macros you may need to override depending on the used tools and operating
    1.26 +system.
    1.27 +
    1.28 +By default, all files will be installed under the "/usr/local" directory, a
    1.29 +different installation path prefix can be set via the `prefix` macro.  In
    1.30 +addition, a second path prefix can be specified via the `DESTDIR` macro which
    1.31 +will be prepended to any path, incuding the `prefix` macro path prefix.  In
    1.32 +contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
    1.33 +prepended to paths during installation and not be used for constructing
    1.34 +internal paths.
    1.35 +
    1.36 +The following instructions assume that `make` is GNU make, on some platforms
    1.37 +it may be installed under a different name or a non-default path.  In order to
    1.38 +start the build process run `make all`.  After a successful build, run `make
    1.39 +install` to install the program, any associated data files and the
    1.40 +documentation.
    1.41 +
    1.42 +Previously generated data files and documentation can be removed by running
    1.43 +`make clean`, any additional, generated files which are not removed by the
    1.44 +`clean` target can be removed by running `make clobber`.
    1.45 +
    1.46 +Contact
    1.47 +-------
    1.48 +
    1.49 +Please send any feedback, translations or bug reports via email to
    1.50 +<guido+relmon@berhoerster.name>.
    1.51 +
    1.52 +Bug Reports
    1.53 +-----------
    1.54 +
    1.55 +When sending bug reports, please always mention the exact version of relmon
    1.56 +with which the issue occurs as well as the version of Tcl and the operating
    1.57 +system you are using and make sure that you provide sufficient information to
    1.58 +reproduce the issue and include any input, output, any error messages.
    1.59 +
    1.60 +In case of build issues, please also specify the implementations and versions
    1.61 +of the used tools.
    1.62 +
    1.63 +In case of crashes, please include the stack trace that was generated by the
    1.64 +Tcl interpreter in the bug report.
    1.65  
    1.66  License
    1.67  -------