index 7371c46e3fcd6f86a64b4e13086bed313bc143ae..f2bfa10927425c87fc22a5d9aab0e0ce6993626b 100644 (file)
--- a/README
+++ b/README
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.
+ license. See COPYING for details. Changes between all SysDB releases can be
+ found in the file ReleaseNotes.
+
+ <https://sysdb.io/>
+
+Configure and install SysDB
+---------------------------
+
+ To configure, build and install SysDB with the default settings, run
+ ‘./configure && make && make install’. For detailed, generic instructions
+ see INSTALL. For a complete list of configure options and their description,
+ run ‘./configure --help’.
+
+ Various third-party packages are required for a full installation of SysDB.
+ See the section ‘Prerequisites’ below for details. A summary of
+ user-supplied and auto-detected build settings is displayed at the end of
+ each ‘configure’ run. Consult this first for trouble-shooting.
+
+ By default, SysDB will be installed into ‘/opt/sysdb’. You can adjust this
+ setting by specifying the ‘--prefix’ configure option - see INSTALL for
+ details. If you pass DESTDIR=<path> to ‘make install’, <path> will be
+ prefixed to all installation directories. This might be useful when creating
+ packages for SysDB.
Prerequisites
-------------
<http://pubs.opengroup.org/onlinepubs/9699919799/>
- * asciidoc, xsltproc, xmlto:
+ * asciidoc, xmlto:
The AsciiDoc text document format is used to write the manpages.
<http://www.methods.co.nz/asciidoc/>
- <http://xmlsoft.org/XSLT/>
<https://fedorahosted.org/xmlto/>
* libedit or libreadline:
tests will be disabled automatically.
For the latest build status, see:
- <https://travis-ci.org/tokkee/sysdb>
+ <https://travis-ci.org/sysdb/sysdb>
Code coverage testing using Gcov may be enabled when using the
‘--enable-gcov’ configure option.
For the latest coverage report, see:
- <https://coveralls.io/r/tokkee/sysdb>
+ <https://coveralls.io/r/sysdb/sysdb>
-Configuring / Compiling / Installing
-------------------------------------
+Documentation
+-------------
- To configure, build and install SysDB with the default settings, run
- ‘./configure && make && make install’. For detailed, generic instructions
- see INSTALL. For a complete list of configure options and their description,
- run ‘./configure --help’.
+ 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 <https://sysdb.io/documentation/>.
- By default, SysDB will be installed into ‘/opt/sysdb’. You can adjust this
- setting by specifying the ‘--prefix’ configure option - see INSTALL for
- details. If you pass DESTDIR=<path> to ‘make install’, <path> will be
- prefixed to all installation directories. This might be useful when creating
- packages for SysDB.
+Getting Help
+------------
+
+ Various channels for asynchronous and real-time communication with
+ developers and users are available. See <https://sysdb.io/contact/> for
+ details about the mailing list, IRC channel, and social media.
Author
------
Sebastian “tokkee” Harl <sh@tokkee.org>
+ See the file THANKS for credits and inspiration.
+
+ Want to contribute? Check out the website <https://sysdb.io> for details.
+