summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThiago da Silva <thiago@redhat.com>2014-02-28 17:31:26 -0500
committerThiago da Silva <thiago@redhat.com>2014-02-28 17:31:26 -0500
commit495d8b5ef6939eefbe8cb0f1c1fed6a927614ed8 (patch)
tree1360ee8261d330f80a6838629528e75c2556619c
parent4185c26e9f6ff6f5395c326e4fb71f60b8d1656e (diff)
Adding installation instructions to README
This text was previously provided by Justing Clift in a pull request. Submitting now as a gerrit review. Change-Id: I2f2bcd894c5eb58318d85b5856366ff31e2a423e Signed-off-by: Thiago da Silva <thiago@redhat.com>
-rw-r--r--README.md23
1 files changed, 20 insertions, 3 deletions
diff --git a/README.md b/README.md
index a7c3787..fb86e26 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,22 @@
# Overview
-Python bindings for GlusterFS libfapi
-# Table of Contents
-1. [Developer Guide](doc/markdown/dev_guide.md)
+Python bindings for the [GlusterFS](http://www.gluster.org) libgfapi interface
+
+# Installation
+
+1) Clone the git repo
+
+```
+$ git clone https://github.com/gluster/libgfapi-python.git
+$ cd libgfapi-python
+```
+
+2) Run the setup script
+
+```
+$ sudo python setup.py install
+```
+
+# Development
+
+* [Developer Guide](doc/markdown/dev_guide.md)