From b25ab0e1dc5196b522f7b02b3ae77b84f4ddbb2a Mon Sep 17 00:00:00 2001
From: Graham Hayes <graham.hayes@hpe.com>
Date: Wed, 13 Jan 2016 18:43:34 +0000
Subject: [PATCH] Update README to RST

This allows the tooling used by the release management team parse the
content to grab links to bug trackers and docs.

Also updated the sample test command to a working one

Change-Id: I1dcfb2b5ae3ba07fbaf6eaabfef1d9e7da778400
Closes-Bug: #1532735
---
 README.md  | 65 ----------------------------------------
 README.rst | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.cfg  |  2 +-
 3 files changed, 88 insertions(+), 66 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/README.md b/README.md
deleted file mode 100644
index 16e7ba15f..000000000
--- a/README.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# Introduction
-
-Designate is an OpenStack inspired DNSaaS.
-
-Docs: http://docs.openstack.org/developer/designate and some below for now.
-Bugs / Blueprints: http://launchpad.net/designate
-
-IRC: #openstack-dns
-
-Installation: http://docs.openstack.org/developer/designate/getting-started.html
-
-# Development
-Designate follows the [OpenStack Gerrit Workflow](http://docs.openstack.org/infra/manual/developers.html#development-workflow)
-
-## Setup
-Setup a working environment:
-
-````
-git clone https://github.com/openstack/designate.git
-cd designate
-virtualenv .venv
-. .venv/bin/activate
-pip install -r requirements.txt -r test-requirements.txt
-python setup.py develop
-````
-
-## Building the documentation
-To build the documentation from the restructured text source, do the following:
-````
-cd doc
-pip install -r requirements.txt
-sphinx-build  source/ build/html/
-````
-now point your browser at html/index.html
-(the official documentation is published to [docs.openstack.org](http://docs.openstack.org/developer/designate) by the
-maintainers.
-
-
-## Contributing
-Install the git-review package to make life easier
-
-````
-pip install git-review
-````
-
-Branch, work, & submit:
-
-````
-# cut a new branch, tracking master
-git checkout --track -b bug/id origin/master
-# work work work
-git add stuff
-git commit
-# rebase/squash to a single commit before submitting
-git rebase -i
-# submit
-git-review
-````
-
-## Testing
-
-Execute a single test using py27 (test is CentralServiceTest.test_count_zones)
-````
-tox -e py27 -- designate.tests.test_central.test_service.CentralServiceTest.test_count_zones
-````
diff --git a/README.rst b/README.rst
new file mode 100644
index 000000000..7e17fde30
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,87 @@
+===================
+OpenStack Designate
+===================
+
+Designate is an OpenStack project, providing DNSaaS.
+
+IRC: #openstack-dns
+
+Installation: http://docs.openstack.org/developer/designate/getting-started.html
+
+
+Development
+===========
+
+Designate follows the `OpenStack Gerrit Workflow`_
+
+Setup
+-----
+
+Setup a working environment:
+
+.. code-block:: shell
+
+    git clone https://github.com/openstack/designate.git
+    cd designate
+    virtualenv .venv
+    . .venv/bin/activate
+    pip install -r requirements.txt -r test-requirements.txt
+    python setup.py develop
+
+Building Docs
+-------------
+
+To build the documentation from the restructured text source, do the following:
+
+.. code-block:: shell
+
+    cd doc
+    pip install -r requirements.txt
+    sphinx-build  source/ build/html/
+
+now point your browser at html/index.html
+(the official documentation is published to `docs.openstack.org`_  by the
+maintainers.
+
+Contributing
+------------
+Install the git-review package to make life easier
+
+.. code-block:: shell
+
+    pip install git-review
+
+
+Branch, work, & submit:
+
+.. code-block:: shell
+
+    # cut a new branch, tracking master
+    git checkout --track -b bug/id origin/master
+    # work work work
+    git add stuff
+    git commit
+    # rebase/squash to a single commit before submitting
+    git rebase -i
+    # submit
+    git-review
+
+Testing
+-------
+
+Execute a single test using py27 (test is CentralServiceTest.test_count_domains)
+
+.. code-block:: shell
+
+    tox -e py27 -- designate.tests.test_central.test_service.CentralServiceTest.test_count_zones_policy_check
+
+
+
+* Free software: Apache license
+* Documentation: http://docs.openstack.org/developer/designate
+* Source: http://git.openstack.org/cgit/openstack/designate
+* Bugs: http://bugs.launchpad.net/designate
+
+
+.. _OpenStack Gerrit Workflow: http://docs.openstack.org/infra/manual/developers.html#development-workflow
+.. _docs.openstack.org: http://docs.openstack.org/developer/designate
\ No newline at end of file
diff --git a/setup.cfg b/setup.cfg
index 6445e6e3f..7a062f451 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -2,7 +2,7 @@
 name = designate
 summary = DNS as a Service
 description-file =
-    README.md
+    README.rst
 author = Kiall Mac Innes
 author-email = kiall@managedit.ie
 home-page = https://launchpad.net/designate