src/graph_ident.c: ident_data_to_json: Average data points ...

[collection4.git] / README

diff --git a/README b/README
index 6083aca2e689382c45208749dece686a513e3519..7cdca157a51d613a3670a9a0dffb50ab68cd1f2d 100644 (file)
--- a/README
+++ b/README
@@ -56,7 +56,26 @@ Concepts
   In the future it shall be possible to use multiple data providers in
   parallel. The vision is to have multiple servers running RRDCacheD. Data is
   distributed to those servers using the "Hashed" match of collectd and then a
-  unified interface is provided via collection 4.
+  unified interface is provided via c4.
+
+
+Dependencies
+------------
+
+  c4 currently requires the following libraries:
+
+  * libfcgi
+    <http://www.fastcgi.com/>
+
+  * librrd_th (thread-safe version of librrd)
+    <http://oss.oetiker.ch/rrdtool/>
+
+  * libyajl
+    <http://lloyd.github.com/yajl/>
+
+  The "configure" script is currently kept minimal. It may therefore be
+  necessary to set the CPP- and LD-flags manually. In case of libyajl, which is
+  not built with libtool, you may need to set the rpath, too.
 
 
 Bugs
@@ -69,7 +88,6 @@ Bugs
   * Currently it's not possible to display more than one graph at a time.
     (With a very limited and undocumented exception.)
   * Speaking of which: There is no documentation.
-  * No default page. -> Redirect to "list_graphs" action.
   * ... (to be added)
 
 
@@ -80,6 +98,15 @@ License
   version 2.1. The exact license terms are available in the file "COPYING" in
   the top source directory.
 
+  c4 includes the JavaScript library "jQuery" which is dual-licensed under the
+  MIT license and the GPL. The file "share/jquery-1.4.2.min.js" includes a
+  license header which points you to more detailed information.
+
+  c4 includes the JavaScript libraries "Raphaël" and "gRaphaël" which are
+  licensed under the MIT license. The files "share/raphael-min.js",
+  "share/g.raphael-min.js", and "share/g.line-min.js" each include a license
+  header which points you to more detailed information.
+
 
 Author
 ------