Mercurial > projects > xwrited

comparison README @ 10:1ec432967d62

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve README file Improve build instructions. Add information on bug reporting. Add contact information.
author Guido Berhoerster <guido+xwrited@berhoerster.name>
date Fri, 09 Jan 2015 17:15:34 +0100
parents f219f96f07c2
children 4a5330979433
comparison
equal deleted inserted replaced
9:92f5322e77c9 10:1ec432967d62
7 notifications. 7 notifications.
8 8
9 Build Instructions 9 Build Instructions
10 ------------------ 10 ------------------
11 11
12 xwrited requires GNU make, GNU gettext, intltool, GNU or BSD install, the 12 xwrited requires a POSIX:2004 compatible operating system, it has been tested
13 xsltproc tool from libxml2 and the following shared libraries to be installed: 13 to work on Linux distributions, FreeBSD, NetBSD, and Solaris and
14 Illumos-derived distributions. The following tools and shared libraries are
15 required to build xwrited:
14 16
17 - GNU make >= 3.81
18 - GNU or BSD install
15 - GLib version 2.26 or later 19 - GLib version 2.26 or later
16 - the D-Bus GLib bindings for GLib < 2.25.5 20 - the D-Bus GLib bindings for GLib < 2.25.5
17 - libutempter on Linux and FreeBSD < 9.0 21 - libutempter on Linux and FreeBSD < 9.0
18 22
19 It has been tested on Linux distributions, FreeBSD, NetBSD, and Solaris 11. 23 Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
24
25 Before building xwrited check the commented macros in the Makefile for any
26 macros you may need to override depending on the used toolchain and operating
27 system.
28
29 By default, all files will be installed under the "/usr/local" directory, a
30 different installation path prefix can be set via the `prefix` macro. In
31 addition, a second path prefix can be specified via the `DESTDIR` macro which
32 will be prepended to any path, incuding the `prefix` macro path prefix. In
33 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
34 prepended to paths during installation and not be used for constructing
35 internal paths.
36
37 The following instructions assume that `make` is GNU make, on some platforms
38 it may be installed under a different name or a non-default path. In order to
39 start the build process run `make all`. After a successful build, run `make
40 install` to install the program, any associated data files and the
41 documentation.
42
43 Previously built binaries, object files, generated data files and
44 documentation can be removed by running `make clean`, any additional,
45 generated files which are not removed by the `clean` target can be removed by
46 running `make clobber`.
47
48 Contact
49 -------
50
51 Please send any feedback, translations or bug reports via email to
52 <guido+xwrited@berhoerster.name>.
53
54 Bug Reports
55 -----------
56
57 When sending bug reports, please always mention the exact version of xwrited
58 with which the issue occurs as well as the version of the operating system you
59 are using and make sure that you provide sufficient information to reproduce
60 the issue and include any input, output, any error messages.
61
62 In case of build issues, please also specify the implementations and versions
63 of the tools and shared libraries used to build the program, in particular the
64 compiler.
65
66 In case of crashes, please generate a stack trace with a suitable debugger
67 such as gdb, lldb, dbx, or debug after a crash has occurred either by
68 examining the resulting core file or by running the program from the debugger
69 and attach it to the bug report. In order to generate a meaningful stack
70 trace the program as well as any dynamically linked libraries need to be built
71 with debugging information, see the documentation of the used compiler for the
72 required compiler flags. If any of the dynamically linked shared libraries do
73 not contain debugging information, please either install debugging information
74 for these libraries using mechanisms provided by your operating system or
75 rebuild the libraries accordingly. Please refer to the documentation of the
76 debugger for detailed instructions on generating backtraces.
20 77
21 License 78 License
22 ------- 79 -------
23 80
24 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and 81 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and