X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=README;h=e9578012ce00157679918eaa77b718f6a500b6c7;hb=923589c5a145693bfd172fd9b211a50c3ab8f1b1;hp=56dde37d9365cbc8ac73939635b6880844140992;hpb=1905dca54fb53caed8171da2fcb842afc9f33216;p=sysdb.git
diff --git a/README b/README
index 56dde37..e957801 100644
--- a/README
+++ b/README
@@ -19,31 +19,80 @@ Prerequisites
* A build environment: autotools, libtool, C compiler, ...
+
+
+
+
+
+
* When building from Git, you also need the flex lexical analyzer generator
and bison parser generator (other lex and yacc compatible tools might work
as well if you are lucky).
+
+
+
* A POSIX + Single UNIX Specification compatible C library.
+
+
* asciidoc, xsltproc, xmlto:
The AsciiDoc text document format is used to write the manpages.
+
+
+
+
+ * libedit or libreadline:
+ A readline compatible command line editor and history library is used for
+ handling input in the sysdb client program.
+
+
+
+
+ The following optional libraries may be used by various plugins:
+
+ * libdbi:
+ The database independent abstraction layer is used for database access by
+ the puppet::store-configs plugin.
+
+
+
+Testing
+-------
+
+ Unit tests for SysDB are shipped along with the source code in the âtâ
+ subdirectory. Run âmake testâ to run all available tests.
+
+ Some tests require the âfopencookieâ function as provided by the GNU libc
+ library. It used used to mock I/O related functions. In case this function
+ is not available, the respective tests will be disabled automatically.
+
+ For the latest build status, see:
+
+
+ Code coverage testing using Gcov may be enabled when using the
+ â--enable-gcovâ configure option.
+
+ For the latest coverage report, see:
+
+
Configuring / Compiling / Installing
------------------------------------
To configure, build and install SysDB with the default settings, run
- `./configure && make && make install'. For detailed, generic instructions
+ â./configure && make && make installâ. For detailed, generic instructions
see INSTALL. For a complete list of configure options and their description,
- run `./configure --help'.
+ run â./configure --helpâ.
- By default, SysDB will be installed into `/opt/sysdb'. You can adjust this
- setting by specifying the `--prefix' configure option - see INSTALL for
- details. If you pass DESTDIR= to `make install', will be
+ By default, SysDB will be installed into â/opt/sysdbâ. You can adjust this
+ setting by specifying the â--prefixâ configure option - see INSTALL for
+ details. If you pass DESTDIR= to âmake installâ, will be
prefixed to all installation directories. This might be useful when creating
packages for SysDB.
Author
------
- Sebastian "tokkee" Harl
+ Sebastian âtokkeeâ Harl