index 1ba71f67c8bcca518f93eefdae039316ca58f855..2d83fae81733a1119945c3dd407f59eb2c1170c0 100644 (file)
--- a/README
+++ b/README
-Round Robin Database Tools
-==========================
-$Id$
+RRDtool - Round Robin Database Tool
+===================================
+
+RRDtool is a little program for easily maintaining a database of time-series
+data. It comes with a charting program for drawing pretty graphs based on
+the data stored.
It is pretty easy to gather status information from all sorts of things,
ranging from the temperature in your office to the number of octets which
To compile:
-----------
-check out the instructions in doc/rrdbuild.txt
+check out the instructions in [[doc/rrdbuild.pod]]
Getting Started:
----------------
To learn:
---------
-Read the documentation in the doc directory. Start of with
-RRDtool. All documents are available as html and as ASCII text.
+Read the documentation in the doc directory.
If you are looking for a more slow paced introduction, make sure to read
Alex van den Bogaerdt's rrdtutorial which is also available from the doc
directory. Also read his cdeftutorial and Steve Rader's rpntutorial.
If you want to know about the format of the log files check
-src/rrd_format.h there are a lot of comments in there ...
+[[src/rrd_format.h]] there are a lot of comments in there ...
How to make Tobi happy:
-----------------------
by going to http://tobi.oetiker.ch/wish and ordering a CD from
my CD wish list ...
-
How to keep in touch:
---------------------
To Contribute:
--------------
-Contributed feature and bug patches are most welcome. But please
-send complete patches. A complete patch patches the CODE as well
-as the CHANGES, CONTRIBUTORS and the POD files.
+Contributed feature and bug patches are most welcome. Since rrdtool lives on
+github, it is now very easy to create pull requests. Work from the master
+branch unless you are creating bugfixes. No new features should go into the
+1.2, 1.3 and 1.4 branches.
-Use GNU diff --unified --recursive olddir newdir to build your patches.
+If you contribute new features, make sure to also update the documentation
+pod files.
-The latest Version:
+The latest released Version:
-------------------
-Is available from http://oss.oetiker.ch/rrdtool/
+Is always available from http://oss.oetiker.ch/rrdtool/
Tobias Oetiker <tobi@oetiker.ch>