projects/xwrited

changeset 10:1ec432967d62

Improve README file

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