plugin: Make sdb_plugin_info_t public.

[sysdb.git] / README

diff --git a/README b/README
index 7371c46e3fcd6f86a64b4e13086bed313bc143ae..191979e1ebe33065271a27e353cb15d51d1d3c20 100644 (file)
--- 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
   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.
+
+  <http://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
 -------------
 
 Prerequisites
 -------------


@@ -46,11 +68,10 @@ Prerequisites
 
     <http://pubs.opengroup.org/onlinepubs/9699919799/>
 
 
     <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/>
     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:
     <https://fedorahosted.org/xmlto/>
 
   * libedit or libreadline:


@@ -90,20 +111,6 @@ Testing
   For the latest coverage report, see:
   <https://coveralls.io/r/tokkee/sysdb>
 
   For the latest coverage report, see:
   <https://coveralls.io/r/tokkee/sysdb>
 

-Configuring / Compiling / Installing
-------------------------------------
-
-  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’.
-
-  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.
-

 Author
 ------
 
 Author
 ------