Browse Source

rst to md

Kentaro Wada 9 years ago
parent
commit
9962d0adbf
4 changed files with 66 additions and 70 deletions
  1. 1 1
      MANIFEST.in
  2. 64 0
      README.md
  3. 0 68
      README.rst
  4. 1 1
      setup.py

+ 1 - 1
MANIFEST.in

@@ -1 +1 @@
-include README.rst
+include README.md

+ 64 - 0
README.md

@@ -0,0 +1,64 @@
+labelme: Image Annotation Tool with Python
+==========================================
+
+Labelme is a graphical image annotation tool inspired by <http://labelme.csail.mit.edu>.
+
+It is written in Python and uses Qt for its graphical interface.
+
+
+Dependencies
+------------
+
+- [PyQt4](http://www.riverbankcomputing.co.uk/software/pyqt/intro)
+
+
+Installation
+------------
+
+On Ubuntu:
+
+```bash
+$ sudo apt-get install python-qt4 qt4-dev-tools
+
+$ sudo pip install labelme
+```
+
+On OS X:
+
+```bash
+$ brew install qt qt4
+
+$ pip install labelme
+```
+
+
+Usage
+-----
+
+```bash
+$ labelme  # Open GUI
+```
+
+The annotations are saved as a [JSON](http://www.json.org/) file. The
+file includes the image itself.
+
+To view the json file quickly, you can use utility script:
+
+```bash
+$ labelme_draw_json sample.json
+```
+
+
+Sample
+------
+
+- [Original Image](https://github.com/wkentaro/labelme/blob/master/_media/IMG_6319.jpg)
+- [Screenshot](https://github.com/wkentaro/labelme/blob/master/_media/IMG_6319_screenshot.png)
+- [Generated Json File](https://github.com/wkentaro/labelme/blob/master/_media/IMG_6319.json)
+- [Visualized Json File](https://github.com/wkentaro/labelme/blob/master/_media/IMG_6319_draw_json.png)
+
+
+Screencast
+----------
+
+<img src="https://github.com/wkentaro/labelme/raw/master/_media/screencast.gif" width="70%"/>

+ 0 - 68
README.rst

@@ -1,68 +0,0 @@
-labelme: Image Annotation Tool with Python
-==========================================
-
-Labelme is a graphical image annotation tool inspired by
-http://labelme.csail.mit.edu.
-
-It is written in Python and uses Qt for its graphical interface.
-
-
-Dependencies
-------------
-
--  `PyQt4 <http://www.riverbankcomputing.co.uk/software/pyqt/intro>`_
-
-
-Installation
-------------
-
-On Ubuntu:
-
-.. code-block:: bash
-
-  $ sudo apt-get install python-qt4 qt4-dev-tools
-
-  $ sudo pip install labelme
-
-
-On OS X:
-
-.. code-block:: bash
-
-  $ brew install qt qt4
-
-  $ pip install labelme
-
-
-Usage
------
-
-.. code:: bash
-
-  $ labelme  # Open GUI
-
-The annotations are saved as a `JSON <http://www.json.org/>`_ file.
-The file includes the image itself.
-
-To view the json file quickly, you can use utility script:
-
-.. code-block:: bash
-
-  $ labelme_draw_json sample.json
-
-
-Sample
-------
-
-- `Original Image <https://github.com/wkentaro/labelme/blob/master/_media/IMG_6319.jpg>`_
-- `Screenshot <https://github.com/wkentaro/labelme/blob/master/_media/IMG_6319_screenshot.png>`_
-- `Generated Json File <https://github.com/wkentaro/labelme/blob/master/_media/IMG_6319.json>`_
-- `Visualized Json File <https://github.com/wkentaro/labelme/blob/master/_media/IMG_6319_draw_json.png>`_
-
-
-Screencast
-----------
-
-.. image:: https://github.com/wkentaro/labelme/raw/master/_media/screencast.gif
-   :width: 80%
-

+ 1 - 1
setup.py

@@ -51,7 +51,7 @@ setup(
     packages=find_packages(),
     cmdclass={'build_py': LabelmeBuildPyCommand},
     description='Simple Image Annotation Tool.',
-    long_description=open('README.rst').read(),
+    long_description=open('README.md').read(),
     author='Kentaro Wada',
     author_email='www.kentaro.wada@gmail.com',
     url='https://github.com/mpitid/pylabelme',