Change README to rst format

README.rst

@@ -1,96 +1,144 @@
-# LabelImg
+LabelImg
+========
 
-[![Build Status](https://travis-ci.org/tzutalin/labelImg.png)](https://travis-ci.org/tzutalin/labelImg)
+.. image:: https://img.shields.io/pypi/v/labelimg.svg
+        :target: https://pypi.python.org/pypi/labelimg
+
+.. image:: https://img.shields.io/travis/tzutalin/labelImg.svg
+        :target: https://travis-ci.org/tzutalin/labelImg
 
 LabelImg is a graphical image annotation tool.
 
 It is written in Python and uses Qt for its graphical interface.
 
-Annotations are saved as XML files in PASCAL VOC format, the format used by [ImageNet](http://www.image-net.org/).
+Annotations are saved as XML files in PASCAL VOC format, the format used
+by `ImageNet <http://www.image-net.org/>`__.
 
-![](demo/demo3.jpg)
+.. image:: https://raw.githubusercontent.com/tzutalin/labelImg/master/demo/demo3.jpg
+     :alt: Demo Image
 
-[Watch a demo video by author tzutalin](https://youtu.be/p0nR2YsCY_U)
+`Watch a demo video by author tzutalin <https://youtu.be/p0nR2YsCY_U>`__
 
-## Get it
+Installation
+------------------
 
-### Download prebuilt binaries
+Download prebuilt binaries
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-* [Windows & Linux](http://tzutalin.github.io/labelImg/)
+-  `Windows & Linux <http://tzutalin.github.io/labelImg/>`__
 
-* OS X
+-  OS X
- * Binaries for OS X are not yet available. Help would be appreciated. At present it must be [built from source](#os-x).
+-  Binaries for OS X are not yet available. Help would be appreciated. At present, it must be `built from source <#os-x>`__.
 
-### Build from source
+Build from source
+~~~~~~~~~~~~~~~~~
 
-Linux/Ubuntu/Mac requires at least [Python 2.6](http://www.python.org/getit/) and has been tested with [PyQt
+Linux/Ubuntu/Mac requires at least `Python
-4.8](http://www.riverbankcomputing.co.uk/software/pyqt/intro).
+2.6 <http://www.python.org/getit/>`__ and has been tested with `PyQt
+4.8 <http://www.riverbankcomputing.co.uk/software/pyqt/intro>`__.
 
-#### Ubuntu Linux
+Ubuntu Linux
+^^^^^^^^^^^^
+
+.. code::
 
     sudo apt-get install pyqt4-dev-tools
     sudo pip install lxml
     make all
     ./labelImg.py
 
-#### OS X
+OS X
+^^^^
+
+.. code::
 
     brew install qt qt4
     brew install libxml2
     make all
     ./labelImg.py
 
-#### Windows
+Windows
+^^^^^^^
 
-Download and setup [Python 2.6 or later](https://www.python.org/downloads/windows/), [PyQt4](https://www.riverbankcomputing.com/software/pyqt/download) and [install lxml](http://lxml.de/installation.html).
+Download and setup `Python 2.6 or
+later <https://www.python.org/downloads/windows/>`__,
+`PyQt4 <https://www.riverbankcomputing.com/software/pyqt/download>`__
+and `install lxml <http://lxml.de/installation.html>`__.
 
-Open cmd and go to [labelImg]
+Open cmd and go to `labelImg <#labelimg>`__ directory
+
+.. code::
 
     pyrcc4 -o resources.py resources.qrc
     python labelImg.py
 
+Usage
+-----
 
-## Usage
+Steps
-
+~~~~~
-### Steps
 
 1. Build and launch using the instructions above.
 2. Click 'Change default saved annotation folder' in Menu/File
 3. Click 'Open Dir'
 4. Click 'Create RectBox'
-5. Click and release left mouse to select a region to annotate the rect box
+5. Click and release left mouse to select a region to annotate the rect
+   box
 6. You can use right mouse to drag the rect box to copy or move it
 
 The annotation will be saved to the folder you specify.
 
 You can refer to the below hotkeys to speed up your workflow.
 
-### Create pre-defined classes
+Create pre-defined classes
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You can edit the [data/predefined_classes.txt](https://github.com/tzutalin/labelImg/blob/master/data/predefined_classes.txt) to load pre-defined classes
+You can edit the
+`data/predefined\_classes.txt <https://github.com/tzutalin/labelImg/blob/master/data/predefined_classes.txt>`__
+to load pre-defined classes
 
-### Hotkeys
+Hotkeys
+~~~~~~~
 
-|          |                                          |
++------------+--------------------------------------------+
-|----------|------------------------------------------|
 | Ctrl + u   | Load all of the images from a directory    |
++------------+--------------------------------------------+
 | Ctrl + r   | Change the default annotation target dir   |
++------------+--------------------------------------------+
 | Ctrl + s   | Save                                       |
++------------+--------------------------------------------+
 | Ctrl + d   | Copy the current label and rect box        |
++------------+--------------------------------------------+
 | Space      | Flag the current image as verified         |
++------------+--------------------------------------------+
 | w          | Create a rect box                          |
++------------+--------------------------------------------+
 | d          | Next image                                 |
++------------+--------------------------------------------+
 | a          | Previous image                             |
++------------+--------------------------------------------+
 | del        | Delete the selected rect box               |
++------------+--------------------------------------------+
 | Ctrl++     | Zoom in                                    |
++------------+--------------------------------------------+
 | Ctrl--     | Zoom out                                   |
++------------+--------------------------------------------+
+
+How to contribute
+~~~~~~~~~~~~~~~~~
 
-### How to contribute
 Send a pull request
 
-### License
+License
-[License](LICENSE.md)
+~~~~~~~
+`Free software: MIT license <https://github.com/tzutalin/labelImg/blob/master/LICENSE>`_
 
-### Related
-1. [ImageNet Utils](https://github.com/tzutalin/ImageNet_Utils) to download image, create a label text for machine learning, etc
 
+Related
+~~~~~~~
+
+1. `ImageNet Utils <https://github.com/tzutalin/ImageNet_Utils>`__ to
+   download image, create a label text for machine learning, etc
+
+.. |Build Status| image:: https://travis-ci.org/tzutalin/labelImg.png
+   :target: https://travis-ci.org/tzutalin/labelImg