diff options
| author | Richard Wall <richard@aziz> | 2010-08-22 22:38:05 +0100 |
|---|---|---|
| committer | Richard Wall <richard@aziz> | 2010-08-22 22:38:05 +0100 |
| commit | 54b3c39b40077b045e7d10b78eaf85b11dad5a3a (patch) | |
| tree | 613de63bd5fa0976e138be2601bd4caf991e61f9 /README | |
| parent | fb130e633439f43a733f5de3bd36aa4f34a89fe2 (diff) | |
| parent | 352f0ea3d709eced87f598b4058d43aff0d5664a (diff) | |
Merge ~richardw/jarmon/auto-apidocumentationv10.8pre1
* Cleanup and add further doc strings for compatibility with yuidoc
* Add a tool to automatically download and run yuidoc on the source tree
* Add a tool to automatically create a releasable source archive containing apidocs
* Add documentation of the apidoc and release tools.
* Rearrange the source tree - moving all examples into the docs/examplesfolder
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. |