Migrate top-level checks to the new parser/analyzer.

[sysdb.git] / README

diff --git a/README b/README
index f2bfa10927425c87fc22a5d9aab0e0ce6993626b..43f6f29aeab6e23bef9fb282f8d9e626a51abb16 100644 (file)
--- a/README
+++ b/README
@@ -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, ...
 
     <http://www.gnu.org/software/automake/>
     <http://www.gnu.org/software/autoconf/>
@@ -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.
 
     <http://libdbi.sourceforge.net/>
 
+  * libfacter:
+    The cfacter library for gathering facts about a system is used by the
+    backend::facter plugin to retrieve attributes about the local system.
+
+    <https://github.com/puppetlabs/cfacter>
+
+  * librrd:
+    The RRDtool library is used by the timeseries::rrdtool plugin to retrieve
+    time-series from RRD files.
+
+    <https://oss.oetiker.ch/rrdtool/>
+
+  * libssl:
+    The Secure Sockets Layer toolkit library is used to encrypt and
+    authenticate TCP connections.
+
+    <http://openssl.org/>
+
 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