From: Marc Koderer Date: Wed, 7 Jan 2015 14:44:26 +0000 (+0100) Subject: Update README.rst to current state X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=6e8fb8bfed1becc0e01de4989f0bdfc8642d4cf1;p=openstack-build%2Fcinder-build.git Update README.rst to current state 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 --- diff --git a/README.rst b/README.rst index 17024f68c..302a1095b 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ 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 `_ -To watch it: http://jenkins.openstack.org +You can raise bugs here http://bugs.launchpad.net/cinder -To hack at it: read `HACKING.rst `_ +Python client +------------- +https://github.com/openstack/python-cinderclient.git