]> review.fuel-infra Code Review - openstack-build/cinder-build.git/commitdiff
Update README.rst to current state
authorMarc Koderer <marc@koderer.com>
Wed, 7 Jan 2015 14:44:26 +0000 (15:44 +0100)
committerMarc Koderer <marc@koderer.com>
Mon, 12 Jan 2015 13:02:24 +0000 (14:02 +0100)
The existing README.rst is outdated. It's referring to
old URL's and can't be used for beginners to get an overview
of the module.

Change-Id: I66b866c35d74e7ec2c319ddcf09db1cfb318eb27

README.rst

index 17024f68c53b8edac81e15a35015959a60223f20..302a1095b84ae10e00a02ec4791a0584a371b0fc 100644 (file)
@@ -1,19 +1,25 @@
-The Choose Your Own Adventure README for Cinder
-===============================================
+======
+CINDER
+======
 
 You have come across a storage service for an open cloud computing service.
-It has identified itself as "Cinder."   It was abstracted from the Nova project.
+It has identified itself as `Cinder`. It was abstracted from the Nova project.
 
-To monitor it from a distance: follow `@openstack <http://twitter.com/openstack>`_ on twitter.
+* Wiki: http://wiki.openstack.org/Cinder
+* Developer docs: http://docs.openstack.org/developer/cinder
 
-To tame it for use in your own cloud: read http://docs.openstack.org
+Getting Started
+---------------
 
-To study its anatomy: read http://cinder.openstack.org
+If you'd like to run from the master branch, you can clone the git repo:
 
-To dissect it in detail: visit http://github.com/openstack/cinder
+    git clone https://github.com/openstack/cinder.git
 
-To taunt it with its weaknesses: use http://bugs.launchpad.net/cinder
+For developer information please see
+`HACKING.rst <https://github.com/openstack/cinder/blob/master/HACKING.rst>`_
 
-To watch it: http://jenkins.openstack.org
+You can raise bugs here http://bugs.launchpad.net/cinder
 
-To hack at it: read `HACKING.rst <https://github.com/openstack/cinder/blob/master/HACKING.rst>`_
+Python client
+-------------
+https://github.com/openstack/python-cinderclient.git