X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=README;h=43f6f29aeab6e23bef9fb282f8d9e626a51abb16;hp=39171c3d73206ebe51277e1f4ceb4132d522b4a4;hb=a248a2d506d3caf06d3cf5284231df6fc583087e;hpb=60da8b040cb9c7374494a02353c9ae439d04d1d5 diff --git a/README b/README index 39171c3..43f6f29 100644 --- a/README +++ b/README @@ -25,7 +25,7 @@ license. See COPYING for details. Changes between all SysDB releases can be found in the file ReleaseNotes. - + Configure and install SysDB --------------------------- @@ -51,7 +51,7 @@ Prerequisites To compile the SysDB package from source you need: - * A build environment: autotools, libtool, C compiler, ... + * A build environment: autotools, libtool, C and C++ compilers, ... @@ -87,15 +87,37 @@ Prerequisites * libdbi: The database independent abstraction layer is used for database access by - the puppet::store-configs plugin. + the backend::puppet::store-configs plugin. + * libfacter: + The cfacter library for gathering facts about a system is used by the + backend::facter plugin to retrieve attributes about the local system. + + + + * librrd: + The RRDtool library is used by the timeseries::rrdtool plugin to retrieve + time-series from RRD files. + + + + * libssl: + The Secure Sockets Layer toolkit library is used to encrypt and + authenticate TCP connections. + + + 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. + in the ‘t’ subdirectory. Run ‘make test’ to run all available tests or use + the following commands to run unit and integration tests separately: + + make test TESTS='$(UNIT_TESTS)' + make test TESTS='$(INTEGRATION_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 @@ -118,13 +140,13 @@ Documentation All documentation for SysDB is available as manual pages (in roff and HTML formats) and shipped alongside the source code in the doc/ subdirectory. - Also, it is available online at . + Also, it is available online at . Getting Help ------------ Various channels for asynchronous and real-time communication with - developers and users are available. See for + developers and users are available. See for details about the mailing list, IRC channel, and social media. Author @@ -134,5 +156,5 @@ Author See the file THANKS for credits and inspiration. - Want to contribute? Check out the website for details. + Want to contribute? Check out the website for details.