Mercurial > projects > pk-update-icon

comparison README @ 44:cf2421217491

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