X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=README;h=d3d4d6200e127d6826b61d24fbd4d68d4db25f4c;hb=e512851481132ca3f18ed3e2c8ea8802b915cd52;hp=55a8be8f983d92bb0b6deecde500f8bcadd3fce1;hpb=bef7167f0dc1fd405e35d5cbffb3c0820945a9ea;p=sysdb.git
diff --git a/README b/README
index 55a8be8..d3d4d62 100644
--- a/README
+++ b/README
@@ -19,27 +19,83 @@ 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:
+
+
+ * 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 and integration 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.
+
+ The integration tests require valgrind. If it is not available, integration
+ 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