Skip to content

Commit

Permalink
rst to md
Browse files Browse the repository at this point in the history
  • Loading branch information
wkentaro committed May 11, 2016
1 parent 958fb3c commit 9962d0a
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 70 deletions.
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1 +1 @@
include README.rst
include README.md
64 changes: 64 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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%"/>
68 changes: 0 additions & 68 deletions README.rst

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def run(self):
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='[email protected]',
url='https://github.com/mpitid/pylabelme',
Expand Down

0 comments on commit 9962d0a

Please sign in to comment.