6c20f6da60
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: https://gist.github.com/b7833f87d5fc23c0b7576967e2c6691b Change-Id: Ia5158a892137a7527d3a40d6e4701675cb9cf587
20 lines
553 B
ReStructuredText
20 lines
553 B
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/charm-guide.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
=====================
|
|
OpenStack Charm Guide
|
|
=====================
|
|
To build the guide, execute the following command::
|
|
|
|
$ tox
|
|
|
|
After running ``tox``, the documentation will be available for viewing
|
|
in HTML format in the ``doc/build/`` directory. View these new documents
|
|
in your favorite web browser.
|