cinder/README.rst
Thierry Carrez 139ff1dfcd Start README.rst with a better title
Now that we are using gitea the contents of our README.rst are
more prominently displayed. Starting it with a "Team and repository
tags" title is a bit confusing. This change makes it start with the
name of the project instead.

While at it, make intro more user-friendly and point to CONTRIBUTING.rst
instead of HACKING.rst for contributor guidance.

Change-Id: I4a93073447b0479b81dbcc877b4fd6b5d15a6a01
2019-11-19 17:48:27 +01:00

35 lines
1.1 KiB
ReStructuredText

================
OpenStack Cinder
================
.. image:: https://governance.openstack.org/tc/badges/cinder.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
OpenStack Cinder is a storage service for an open cloud computing service.
You can learn more about Cinder at:
* Wiki: https://wiki.openstack.org/Cinder
* Developer docs: https://docs.openstack.org/cinder/latest/
* Blueprints: https://blueprints.launchpad.net/cinder
* Release notes: https://docs.openstack.org/releasenotes/cinder/
* Design specifications: https://specs.openstack.org/openstack/cinder-specs/
Getting Started
---------------
If you'd like to run from the master branch, you can clone the git repo:
git clone https://opendev.org/openstack/cinder
If you'd like to contribute, please see the information in
`CONTRIBUTING.rst <https://opendev.org/openstack/cinder/src/branch/master/CONTRIBUTING.rst>`_
You can raise bugs here https://bugs.launchpad.net/cinder
Python client
-------------
https://opendev.org/openstack/python-cinderclient