From: Christian Jurk Date: Sat, 11 Oct 2014 09:48:29 +0000 (+0200) Subject: Update README.md X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ab889c8465df15c3004a0def9b4228ce6ad06c04;p=people%2Fms%2Fpython-rrdtool.git Update README.md Added information on how to install, especially via pip or similar. --- diff --git a/README.md b/README.md index 8afd59d..20bf7af 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ python-rrdtool ============== -Python bindings for rrdtool with a native C extension and an object-oriented way to work with Round Robin Databases. As of version 0.1.1, Python 2 and 3 is supported. +Python bindings for [RRDtool](http://oss.oetiker.ch/rrdtool) with a native C extension and an object-oriented way to work with Round Robin Databases. As of version 0.1.1, Python 2 and 3 is supported. The bindings are based on the code of the original Python 2 bindings for rrdtool by Hye-Shik Chang. @@ -10,10 +10,9 @@ Installation In order to build the native C extension (which is an required step), you'll need librrd and its headers installed. Having rrdtool installed should be enough on most distributions. -**How to Install?** +The easy way to install is to use `pip install rrdtool` or `easy_install rrdtool` -1. Download a copy of the repository. -2. Run `python setup.py install` to build an install the native C extension as well as the RRD module. +In case you'd like to build the module on your own, you can obtain a copy of the repository and run `python setup.py install` in it's destination folder to build the native C extension as well as the RRD module. Usage ----- @@ -82,4 +81,4 @@ Christian Jurk This binding was created because I am currently porting some existing Python 2 code to Python 3 and try to help the community by contributing a updated binding extension. Hope someone can benefit from it. -If you encounter any bugs (which I expected at time of writing this), please submit them in the issue tracker here on the project page on Github. Thank you. \ No newline at end of file +If you encounter any bugs (which I expected at time of writing this), please submit them in the issue tracker here on the project page on Github. Thank you.