X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=README;h=a681916c3cbcc0cdf141de7664f1a5f5d8262e1e;hb=7624ec9003444dbd76f03dfeda38167f3831fc48;hp=191979e1ebe33065271a27e353cb15d51d1d3c20;hpb=bd226461afd5fb14daec426877db14bcb113d5c4;p=sysdb.git
diff --git a/README b/README
index 191979e..a681916 100644
--- a/README
+++ b/README
@@ -16,14 +16,16 @@
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
---------------------------
@@ -49,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, ...
@@ -85,10 +87,22 @@ 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.
+
+
+
Testing
-------
@@ -103,16 +117,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.
+