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