Merged branch 'upstream'.

[pkg-rrdtool.git] / README

diff --git a/README b/README
index ac18e6c1e18a3d454387074a48f8c16e6944ee57..2d83fae81733a1119945c3dd407f59eb2c1170c0 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,9 @@
-Round Robin Database Tools
-==========================
-$Id: README 1844 2009-06-07 11:35:52Z oetiker $
+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
@@ -15,7 +18,7 @@ values collected over a definable time period.
 To compile:
 -----------
 
-check out the instructions in doc/rrdbuild.txt
+check out the instructions in [[doc/rrdbuild.pod]]
 
 Getting Started:
 ----------------
@@ -26,15 +29,14 @@ RRDtool applications in the examples directory.
 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:
 -----------------------
@@ -43,7 +45,6 @@ If you want to show your appreciation for RRDtool you could make me happy
 by going to http://tobi.oetiker.ch/wish and ordering a CD from
 my CD wish list ... 
 
-
 How to keep in touch:
 ---------------------
 
@@ -62,15 +63,17 @@ to rrd-users and rrd-developers as well.
 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>