share/collection.js: Keep visibility when redrawing graphs.

[collection4.git] / README

diff --git a/README b/README
index 82b268a..ba15369 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,6 @@
  collection 4 - An efficient graphing front-end for collectd
 =============================================================
  collection 4 - An efficient graphing front-end for collectd
 =============================================================

+<http://octo.it/c4/>

 
 About
 -----
 
 About
 -----


@@ -53,6 +54,49 @@ Concepts
   solution integrated in the C code (creating rendered graphics) and / or a
   JavaScript-based solution which renders graphs in the browser.
 
   solution integrated in the C code (creating rendered graphics) and / or a
   JavaScript-based solution which renders graphs in the browser.
 

+  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 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.
+
+  When building from the Git repository, you'll need to have flex and bison (or
+  possibly lex and yacc) installed. These two programs are used to generate the
+  code for parsing the config file. If you are building from a tarball, the
+  generated .c and .h files are included and you don't need to have these
+  programs installed.
+
+
+Bugs
+----
+
+  * Sending a FLUSH command to the collectd process is not yet possible.
+  * "*_get_rrdargs" functions and other RRDtool specific cruft is still all
+    over the code-base.
+  * The JSON-based interface is unstable.
+  * 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.
+  * ... (to be added)
+

 
 License
 -------
 
 License
 -------


@@ -61,6 +105,17 @@ License
   version 2.1. The exact license terms are available in the file "COPYING" in
   the top source directory.
 
   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 library "Highcharts" which is licensed under the
+  Creative Commons Attribution-NonCommercial 3.0 License (CC-by-nc 3.0). This
+  means that the library is free of charge for non-commercial use. The file
+  "share/highcharts.js" includes a license header which points you to more
+  detailed information. More information on Highcharts and licensing options is
+  available from <http://www.highcharts.com/>.
+

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