Mercurial > projects > rantaiwarna

comparison README @ 8:0ec0edfcb752

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+rantaiwarna@berhoerster.name>
date Fri, 23 Jan 2015 11:08:04 +0100
parents a9a7ad180c3b
children
comparison
equal deleted inserted replaced
7:2ff9656aad52 8:0ec0edfcb752
16 by sliding columns on the right side of the column gap to the left. 16 by sliding columns on the right side of the column gap to the left.
17 17
18 Build Instructions 18 Build Instructions
19 ------------------ 19 ------------------
20 20
21 rantaiwarna requires a POSIX:2004 compatible operating system, and needs GNU 21 rantaiwarna requires a POSIX:2004 compatible operating system, it has been
22 make, GNU or BSD install, the xsltproc tool from libxml2 and an implementation 22 tested to work on Linux distributions, FreeBSD, NetBSD, Solaris and
23 of the curses library compatible with X/Open CURSES Issue 4 to be installed. 23 Illumos-derived distributions, and UnixWare. The following tools and shared
24 It can take advantage of advanced features of recent ncurses versions, in 24 libraries are required to build rantaiwarna:
25 particular mouse support, but it also works with the native curses 25
26 implementations of Solaris, NetBSD, and UnixWare. It has been tested on Linux 26 - GNU make >= 3.81
27 distributions, FreeBSD, Solaris and Illumos-derived distributions, UnixWare, 27 - GNU or BSD install
28 and OpenServer. 28 - an implementation of the curses library compatible with X/Open CURSES
29 Issue 4 (rantaiwarna can take advantage of advanced features of recent
30 ncurses versions, in particular mouse support, but it also works with the
31 native curses implementations of at least Solaris, NetBSD, and UnixWare)
32
33 Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
34
35 Before building rantaiwarna check the commented macros in the Makefile for any
36 macros you may need to override depending on the used toolchain and operating
37 system.
38
39 By default, all files will be installed under the "/usr/local" directory, a
40 different installation path prefix can be set via the `prefix` macro. In
41 addition, a second path prefix can be specified via the `DESTDIR` macro which
42 will be prepended to any path, incuding the `prefix` macro path prefix. In
43 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
44 prepended to paths during installation and not be used for constructing
45 internal paths.
46
47 The following instructions assume that `make` is GNU make, on some platforms
48 it may be installed under a different name or a non-default path. In order to
49 start the build process run `make all`. After a successful build, run `make
50 install` to install the program, any associated data files and the
51 documentation.
52
53 Previously built binaries, object files, generated data files and
54 documentation can be removed by running `make clean`, any additional,
55 generated files which are not removed by the `clean` target can be removed by
56 running `make clobber`.
57
58 Contact
59 -------
60
61 Please send any feedback, translations or bug reports via email to
62 <guido+rantaiwarna@berhoerster.name>.
63
64 Bug Reports
65 -----------
66
67 When sending bug reports, please always mention the exact version of
68 rantaiwarna with which the issue occurs as well as the version of the
69 operating system you are using and make sure that you provide sufficient
70 information to reproduce the issue and include any input, output, any error
71 messages.
72
73 In case of build issues, please also specify the implementations and versions
74 of the tools and shared libraries used to build the program, in particular the
75 compiler.
76
77 In case of crashes, please generate a stack trace with a suitable debugger
78 such as gdb, lldb, dbx, or debug after a crash has occurred either by
79 examining the resulting core file or by running the program from the debugger
80 and attach it to the bug report. In order to generate a meaningful stack
81 trace the program as well as any dynamically linked libraries need to be built
82 with debugging information, see the documentation of the used compiler for the
83 required compiler flags. If any of the dynamically linked shared libraries do
84 not contain debugging information, please either install debugging information
85 for these libraries using mechanisms provided by your operating system or
86 rebuild the libraries accordingly. Please refer to the documentation of the
87 debugger for detailed instructions on generating backtraces.
29 88
30 License 89 License
31 ------- 90 -------
32 91
33 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and 92 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and