changeset 44:cf2421217491

Improve README file

Improve build instructions.
Add information on bug reporting.
Add contact information.
author Guido Berhoerster <>
date Fri Jan 09 17:09:21 2015 +0100 (2015-01-09)
parents 12cdb3d305a3
children a29fbf0a7f6c
files README
line diff
     1.1 --- a/README	Tue Nov 18 09:37:57 2014 +0100
     1.2 +++ b/README	Fri Jan 09 17:09:21 2015 +0100
     1.3 @@ -10,20 +10,75 @@
     1.4  Build Instructions
     1.5  ------------------
     1.7 -pk-update-icon requires GNU make, GNU gettext, GNU or BSD install, the
     1.8 -xsltproc tool from libxml2 and the following shared libraries to be installed:
     1.9 +pk-update-icon requires a POSIX:2004 compatible operating system, it has been
    1.10 +tested to work on Linux distributions.  The following tools and shared
    1.11 +libraries are required to build pk-update-icon:
    1.13 +- GNU make >= 3.81
    1.14 +- pkg-config
    1.15 +- GNU gettext
    1.16 +- GNU or BSD install
    1.17  - GLib version 2.30 or later
    1.18  - GTK+ version 2.24 or later
    1.19  - libunique
    1.20  - libnotify
    1.21  - PackageKit-glib2
    1.23 -Authors
    1.24 +Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
    1.25 +
    1.26 +Before building pk-update-icon check the commented macros in the Makefile for
    1.27 +any macros you may need to override depending on the used toolchain and
    1.28 +operating system.
    1.29 +
    1.30 +By default, all files will be installed under the "/usr/local" directory, a
    1.31 +different installation path prefix can be set via the `prefix` macro.  In
    1.32 +addition, a second path prefix can be specified via the `DESTDIR` macro which
    1.33 +will be prepended to any path, incuding the `prefix` macro path prefix.  In
    1.34 +contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
    1.35 +prepended to paths during installation and not be used for constructing
    1.36 +internal paths.
    1.37 +
    1.38 +The following instructions assume that `make` is GNU make, on some platforms
    1.39 +it may be installed under a different name or a non-default path.  In order to
    1.40 +start the build process run `make all`.  After a successful build, run `make
    1.41 +install` to install the program, any associated data files and the
    1.42 +documentation.
    1.43 +
    1.44 +Previously built binaries, object files, generated data files and
    1.45 +documentation can be removed by running `make clean`, any additional,
    1.46 +generated files which are not removed by the `clean` target can be removed by
    1.47 +running `make clobber`.
    1.48 +
    1.49 +Contact
    1.50  -------
    1.52 -pk-update-icon was initially created by Pavol Rusnak and later rewritten by
    1.53 -Guido Berhoerster.
    1.54 +Please send any feedback, translations or bug reports via email to
    1.55 +<>.
    1.56 +
    1.57 +Bug Reports
    1.58 +-----------
    1.59 +
    1.60 +When sending bug reports, please always mention the exact version of
    1.61 +pk-update-icon with which the issue occurs as well as the version of the
    1.62 +operating system you are using and make sure that you provide sufficient
    1.63 +information to reproduce the issue and include any input, output, any error
    1.64 +messages.
    1.65 +
    1.66 +In case of build issues, please also specify the implementations and versions
    1.67 +of the tools and shared libraries used to build the program, in particular the
    1.68 +compiler.
    1.69 +
    1.70 +In case of crashes, please generate a stack trace with a suitable debugger
    1.71 +such as gdb, lldb, dbx, or debug after a crash has occurred either by
    1.72 +examining the resulting core file or by running the program from the debugger
    1.73 +and attach it to the bug report.  In order to generate a meaningful stack
    1.74 +trace the program as well as any dynamically linked libraries need to be built
    1.75 +with debugging information, see the documentation of the used compiler for the
    1.76 +required compiler flags.  If any of the dynamically linked shared libraries do
    1.77 +not contain debugging information, please either install debugging information
    1.78 +for these libraries using mechanisms provided by your operating system or
    1.79 +rebuild the libraries accordingly.  Please refer to the documentation of the
    1.80 +debugger for detailed instructions on generating backtraces.
    1.82  License
    1.83  -------