From 64e2f01f1a57836ebb06be169ea85756ae858c3e Mon Sep 17 00:00:00 2001
From: jaseg <code@jaseg.net>
Date: Sun, 8 Jul 2018 13:29:14 +0200
Subject: [PATCH] Convert README to rst for display on PyPI

---
 README.md  | 60 ----------------------------------
 README.rst | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.py   |  5 +--
 3 files changed, 97 insertions(+), 62 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/README.md b/README.md
deleted file mode 100644
index f741f80..0000000
--- a/README.md
+++ /dev/null
@@ -1,60 +0,0 @@
-pcb-tools
-============
-[![Travis CI Build Status](https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master)](https://travis-ci.org/curtacircuitos/pcb-tools)
-[![Coverage Status](https://coveralls.io/repos/curtacircuitos/pcb-tools/badge.png?branch=master)](https://coveralls.io/r/curtacircuitos/pcb-tools?branch=master)
-[![Documentation Status](https://readthedocs.org/projects/pcb-tools/badge/?version=latest)](https://readthedocs.org/projects/pcb-tools/?badge=latest)
-
-Tools to handle Gerber and Excellon files in Python.
-
-Usage Example:
----------------
-    import gerber
-    from gerber.render import GerberCairoContext
-
-    # Read gerber and Excellon files
-    top_copper = gerber.read('example.GTL')
-    nc_drill = gerber.read('example.txt')
-
-    # Rendering context
-    ctx = GerberCairoContext()
-
-    # Create SVG image
-    top_copper.render(ctx)
-    nc_drill.render(ctx, 'composite.svg')
-
-
-Rendering Examples:
--------------------
-### Top Composite rendering
-![Composite Top Image](examples/cairo_example.png)
-![Composite Bottom Image](examples/cairo_bottom.png)
-
-Source code for this example can be found [here](examples/cairo_example.py).
-
-
-Install from source:
-```
-$ git clone https://github.com/curtacircuitos/pcb-tools.git
-$ cd pcb-tools
-$ pip install -r requirements.txt
-$ python setup.py install
-```
-
-Documentation:
---------------
-[PCB Tools Documentation](http://pcb-tools.readthedocs.org/en/latest/)
-
-
-Development and Testing:
-------------------------
-
-Dependencies for developing and testing pcb-tools are listed in test-requirements.txt. Use of a virtual environment is strongly recommended.
-
-    $ virtualenv venv
-    $ source venv/bin/activate
-    (venv)$ pip install -r test-requirements.txt
-    (venv)$ pip install -e .
-
-We use nose to run pcb-tools's suite of unittests and doctests.
-
-    (venv)$ nosetests
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..2028fa6
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,94 @@
+pcb-tools
+=========
+
+|buildstatus| |coverage| |docstatus|
+
+.. |buildstatus| image:: https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master
+   :alt: Travis CI Build Status
+   :target: https://travis-ci.org/curtacircuitos/pcb-tools
+
+.. |coverage| image:: https://coveralls.io/repos/curtacircuitos/pcb-tools/badge.png?branch=master
+   :alt: Coverage Status
+   :target: https://coveralls.io/r/curtacircuitos/pcb-tools?branch=master
+
+
+.. |docstatus| image:: https://readthedocs.org/projects/pcb-tools/badge/?version=latest
+   :alt: Documentation Status
+   :target: https://readthedocs.org/projects/pcb-tools/?badge=latest
+
+Tools to handle Gerber and Excellon files in Python.
+
+Usage Example:
+---------------
+
+.. code:: python
+
+    import gerber
+    from gerber.render import GerberCairoContext
+
+    # Read gerber and Excellon files
+    top_copper = gerber.read('example.GTL')
+    nc_drill = gerber.read('example.txt')
+
+    # Rendering context
+    ctx = GerberCairoContext()
+
+    # Create SVG image
+    top_copper.render(ctx)
+    nc_drill.render(ctx, 'composite.svg')
+
+
+Rendering Examples
+-------------------
+
+Top Composite rendering
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. image:: https://raw.githubusercontent.com/curtacircuitos/pcb-tools/master/examples/cairo_example.png
+   :alt: Composite Top Image
+
+Bottom Composite rendering
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. image:: https://raw.githubusercontent.com/curtacircuitos/pcb-tools/master/examples/cairo_bottom.png
+   :alt: Composite Bottom Image
+
+Source code for this example can be found `on github`_.
+
+.. _`on github`: https://github.com/curtacircuitos/pcb-tools/blob/master/examples/cairo_example.py
+
+
+Install from source:
+
+.. code:: sh
+
+        $ git clone https://github.com/curtacircuitos/pcb-tools.git
+        $ cd pcb-tools
+        $ pip install -r requirements.txt
+        $ python setup.py install
+
+Documentation
+-------------
+
+You can find the documentation for PCB-Tools on readthedocs_.
+
+.. _readthedocs: http://pcb-tools.readthedocs.org/en/latest/
+
+
+Development and Testing
+-----------------------
+
+Dependencies for developing and testing pcb-tools are listed in test-requirements.txt. Use of a virtual environment is strongly recommended.
+
+.. code:: sh
+
+    $ virtualenv venv
+    $ source venv/bin/activate
+    (venv)$ pip install -r test-requirements.txt
+    (venv)$ pip install -e .
+
+We use nose to run pcb-tools's suite of unittests and doctests.
+
+.. code:: sh
+
+    (venv)$ nosetests
diff --git a/setup.py b/setup.py
index 1df0868..3fb2e27 100644
--- a/setup.py
+++ b/setup.py
@@ -22,7 +22,7 @@ def read(fname):
 
 METADATA = {
     'name': 'pcb-tools',
-    'version': 0.1,
+    'version': '0.1.4',
     'author': 'Paulo Henrique Silva <ph.silva@gmail.com>, Hamilton Kibbe <ham@hamiltonkib.be>',
     'author_email': "ph.silva@gmail.com, ham@hamiltonkib.be",
     'description': ("Utilities to handle Gerber (RS-274X) files."),
@@ -30,7 +30,8 @@ def read(fname):
     'keywords': "pcb gerber tools",
     'url': "http://github.com/curtacircuitos/pcb-tools",
     'packages': ['gerber', 'gerber.render'],
-    'long_description': read('README.md'),
+    'long_description': read('README.rst'),
+    'long_description_content_type': 'text/x-rst',
     'classifiers':[
         "Development Status :: 3 - Alpha",
         "Topic :: Utilities",