Mercurial > projects > relmon

comparison README @ 8:a886a736c766

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve README file Add build instructions. Add information on bug reporting. Add contact information.
author Guido Berhoerster <guido+relmon@berhoerster.name>
date Fri, 23 Jan 2015 11:05:36 +0100
parents f28486666a4f
children
comparison
equal deleted inserted replaced
7:a3a833118423 8:a886a736c766
15 15
16 The recorded information on each software project can be output in several 16 The recorded information on each software project can be output in several
17 different formats, including formatted text, machine-parseable text, and HTML, 17 different formats, including formatted text, machine-parseable text, and HTML,
18 optionally with the history of releases in Atom feed fromat. 18 optionally with the history of releases in Atom feed fromat.
19 19
20 Requirements 20 Build Instructions
21 ------------ 21 ------------------
22 22
23 relmon requires GNU make, GNU or BSD install, the xsltproc tool from libxml2, 23 relmon requires Tcl 8.5 or later, tcllib, tls, and tdom and has been tested to
24 Tcl 8.5 or later, tcllib, tls, and tdom. It has been tested on Linux 24 work on Linux distributions and FreeBSD. The following tools are required to
25 distributions and FreeBSD. 25 build relmon:
26
27 - GNU make >= 3.81
28 - GNU or BSD install
29
30 Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
31
32 Before building relmon check the commented macros in the Makefile for any
33 macros you may need to override depending on the used tools and operating
34 system.
35
36 By default, all files will be installed under the "/usr/local" directory, a
37 different installation path prefix can be set via the `prefix` macro. In
38 addition, a second path prefix can be specified via the `DESTDIR` macro which
39 will be prepended to any path, incuding the `prefix` macro path prefix. In
40 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
41 prepended to paths during installation and not be used for constructing
42 internal paths.
43
44 The following instructions assume that `make` is GNU make, on some platforms
45 it may be installed under a different name or a non-default path. In order to
46 start the build process run `make all`. After a successful build, run `make
47 install` to install the program, any associated data files and the
48 documentation.
49
50 Previously generated data files and documentation can be removed by running
51 `make clean`, any additional, generated files which are not removed by the
52 `clean` target can be removed by running `make clobber`.
53
54 Contact
55 -------
56
57 Please send any feedback, translations or bug reports via email to
58 <guido+relmon@berhoerster.name>.
59
60 Bug Reports
61 -----------
62
63 When sending bug reports, please always mention the exact version of relmon
64 with which the issue occurs as well as the version of Tcl and the operating
65 system you are using and make sure that you provide sufficient information to
66 reproduce the issue and include any input, output, any error messages.
67
68 In case of build issues, please also specify the implementations and versions
69 of the used tools.
70
71 In case of crashes, please include the stack trace that was generated by the
72 Tcl interpreter in the bug report.
26 73
27 License 74 License
28 ------- 75 -------
29 76
30 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and 77 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and