Merge "Update README to RST" into stable/liberty

3 files changed, 88 insertions, 66 deletions

diff --git a/README.md b/README.md
deleted file mode 100644
index 3e29324c..00000000
--- 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_domains)
-````
-tox -e py27 -- designate/tests/test_central/test_service.py:CentralServiceTest.test_count_domains
-````
diff --git a/README.rst b/README.rst
new file mode 100644
index 00000000..7e17fde3
--- /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 15bc9d2a..af1e1a87 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