Merge branch 'add-readme' into 'master'

[readme] updated README file



See merge request !2

README.rst

+.. vim: set fileencoding=utf-8 :
+.. Fri 19 Aug 17:13:44 CEST 2016
+
+.. image:: http://img.shields.io/badge/docs-stable-yellow.png
+   :target: http://pythonhosted.org/<PACKAGE>/index.html
+.. image:: http://img.shields.io/badge/docs-latest-orange.png
+   :target: https://www.idiap.ch/software/bob/docs/latest/bob/<PACKAGE>/master/index.html
+.. image:: https://gitlab.idiap.ch/bob/<PACKAGE>/badges/master/build.svg
+   :target: https://gitlab.idiap.ch/bob/<PACKAGE>/commits/master
+.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
+   :target: https://gitlab.idiap.ch/bob/<PACKAGE>
+.. image:: http://img.shields.io/pypi/v/<PACKAGE>.png
+   :target: https://pypi.python.org/pypi/<PACKAGE>
+.. image:: http://img.shields.io/pypi/dm/<PACKAGE>.png
+   :target: https://pypi.python.org/pypi/<PACKAGE>
+
+
+=========
  Image Key Point Annotation Tool
-===============================
+=========
+
+This package is part of the signal-processing and machine learning toolbox
+Bob_.  Image Key Point Annotation Tool is a small TkInter-based keypoint annotation tool for images written in Python.
 
-A small TkInter-based keypoint annotation tool for images written in Python.
 
 Installation
 ------------
 
-Follow our `binary installation
-<https://github.com/idiap/bob/wiki/Binary-Installation>`_ instructions. Then,
-using the Python interpreter inside that distribution, bootstrap and buildout
-this package::
+Follow our `installation`_ instructions. Then, using the Python interpreter
+provided by the distribution, bootstrap and buildout this package::
 
   $ python bootstrap-buildout.py
   $ ./bin/buildout
@@ -25,8 +43,31 @@ like object detection or segmentation. Start with::
   $ ./bin/annotate.py --help
 
 
+Annotation of lines
+----------------------
+
+The tool ``annotate_line.py`` allows you to annotate lines in images
+(multiple lines per one image). It is useful to annotate lines for tasks
+like object detection or segmentation. Start with::
+
+  $ ./bin/annotate_line.py --help
+
+
 Annotation format
 =================
 
 The annotation file will contain points in the ``(y,x)`` (Bob-style) format.
 Every line corresponds to one point annotated on the original image.
+
+
+Contact
+-------
+
+For questions or reporting issues to this software package, contact our
+development `mailing list`_.
+
+
+.. Place your references here:
+.. _bob: https://www.idiap.ch/software/bob
+.. _installation: https://gitlab.idiap.ch/bob/bob/wikis/Installation
+.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel