X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=README;h=c78ec5fea715d77fb60c15c477e8a567a9f15f2f;hb=05f8e6e8f6132ef71e51280a75a9ad9aa0c00665;hp=7371c46e3fcd6f86a64b4e13086bed313bc143ae;hpb=70a3f7daeac51f82b5d81dedc5ad8ca267d72173;p=sysdb.git diff --git a/README b/README index 7371c46..c78ec5f 100644 --- a/README +++ b/README @@ -20,7 +20,29 @@ like the current memory utilization or much more. 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. + + + +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= to ‘make install’, will be + prefixed to all installation directories. This might be useful when creating + packages for SysDB. Prerequisites ------------- @@ -46,11 +68,10 @@ Prerequisites - * asciidoc, xsltproc, xmlto: + * asciidoc, xmlto: The AsciiDoc text document format is used to write the manpages. - * libedit or libreadline: @@ -90,22 +111,26 @@ Testing For the latest coverage report, see: -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 . - 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= to ‘make install’, 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 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. +