X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=README;h=f2bfa10927425c87fc22a5d9aab0e0ce6993626b;hb=85eaead5123f086d41ba61b459ac320cd6324a1b;hp=191979e1ebe33065271a27e353cb15d51d1d3c20;hpb=4cf5f6607b603fd50fc667fdea5cda800daf5a78;p=sysdb.git diff --git a/README b/README index 191979e..f2bfa10 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 --------------------------- @@ -103,16 +105,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. +