From: Sebastian Harl Date: Sun, 22 Dec 2013 16:17:42 +0000 (+0100) Subject: Updated README. X-Git-Tag: sysdb-0.1.0~286 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=9857c9fadcb50e2b3d8c3571239906c10074d10b;p=sysdb.git Updated README. Added missing dependencies, links to dependency upstream homepages, and some notes about testing. --- diff --git a/README b/README index 56dde37..1db2239 100644 --- a/README +++ b/README @@ -19,31 +19,74 @@ 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. + + Code coverage testing using Gcov may be enabled when using the + ‘--enable-gcov’ configure option. + 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