diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 24 |
1 files changed, 19 insertions, 5 deletions
@@ -1,15 +1,19 @@ -Jarmon 0.0.1 +Jarmon 10.7 What is this? ============= -Wrappers and convenience fuctions for working with the javascriptRRD, Flot and -Collectd. +jarmon.js contains various wrappers and convenience fuctions for working with +the javascriptRRD, Flot and RRD files generated by eg Collectd. +Additionally, there is a fully working example which demonstrates how to use +jarmon.js and how to integrate it with other javascript components - such as +calendar date pickers etc. Debian / Ubuntu Quick Start =========================== -To get this demo working, you will need to serve this page from a +There is a demo html page in the docs/examples folder. +To get this demo working, you will need to serve that page from a local webserver and serve the folder that contains your RRD files. This demo is designed to work with the RRD files generated by @@ -25,10 +29,20 @@ $ bzr branch lp:~richardw/jarmon/trunk $ cd trunk # Link to the collectd rrd folder -$ ln -s /var/lib/collectd/rrd/localhost data +$ ln -s /var/lib/collectd/rrd/localhost docs/examples/data # Start a local webserver - here we use Twisted, but there are other web server # config examples in docs/ $ aptitude install twisted $ twistd -n web --port 8080 --path . +$ firefox http://localhost:8080/docs/examples/index.html + + +Next Steps +========== +Examine: + * docs/examples/index.html + * docs/examples/jarmon_example_recipes.js + +...for examples of how to use jarmon.js then add your own chart recipes. |