performance-docs/README.rst
Flavio Percoco ad07795260 Show team and repo badges on README
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/530e0e5b4b1d18aa8296e0daaeb95158

Change-Id: I86716b7c68ff5012034f5a14d2c4907013b93556
2016-11-25 17:34:42 +01:00

33 lines
777 B
ReStructuredText

========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/performance-docs.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
OpenStack Performance Documentation
===================================
This repository is for OpenStack performance testing plans, results and investigation documents.
All documents are in RST format and located in `doc/source/` sub-folder.
Building
========
Prerequisites
-------------
To get started, you need to install all necessary tools:
* `virtualenv`
* `pip` (use the latest from `https://bootstrap.pypa.io/get-pip.py`)
* `tox`
* system dependencies: `libjpeg-dev`
Run the build
-------------
$ tox