X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=inline;f=README;h=43f6f29aeab6e23bef9fb282f8d9e626a51abb16;hb=b8cdba842519c2de8ffdf5e2464c9fe637ea6b15;hp=97dc2fe6194995d651d2e6dbfd3c866dff81b32a;hpb=125e7cfb1cfb48c9d6654766abfae3dfea1030fe;p=sysdb.git
diff --git a/README b/README
index 97dc2fe..43f6f29 100644
--- a/README
+++ b/README
@@ -16,13 +16,17 @@
like a software system. Both, hosts and services, may reference a list of
attributes which represent further information about the respective host or
service object. For example, attributes may specify static information like
- a host's architecture or the software version or reference performance data
- like the current memory utilization or much more.
+ a host's architecture or the software version. A host may also reference a
+ list of metrics which are references to performance data stored about the
+ host. SysDB supports querying the respective time-series from a backend's
+ data store.
SysDB is free and open source software, licensed under the 2-clause BSD
license. See COPYING for details. Changes between all SysDB releases can be
found in the file ReleaseNotes.
+
+
Configure and install SysDB
---------------------------
@@ -47,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, ...
@@ -83,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
@@ -101,16 +127,34 @@ Testing
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:
-
+
+
+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 .
+
+Getting Help
+------------
+
+ Various channels for asynchronous and real-time communication with
+ developers and users are available. See for
+ details about the mailing list, IRC channel, and social media.
Author
------
Sebastian âtokkeeâ Harl
+ See the file THANKS for credits and inspiration.
+
+ Want to contribute? Check out the website for details.
+