commit f99bbabdbe681c78334a7f735f51fe0eeefbb924
Author: Jan Grewe <jan.grewe@g-node.org>
Date:   Sat Dec 19 18:12:18 2020 +0100

    add readme

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..85a2efd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Tracking tools
+
+Small collection of tools that should help to work with the tracking data.
+
+## Contents
+
+1) **image_marker.py** Tool to set markers in an image, respectively a single frame of a movie.
+2) **tracking_result.py** defines a small class easing the handling of DeepLabCut h5 files containing the tracking results.
+3) **test.py** scirpt to demonstrate using the aforementioned files/classes.
+
+## Requirements
+
+* **Open CV** - for opening movies (to install ``pip3 install opencv-python-headless``)
+* **pandas** - For reading the h5 files dumped by DeepLabCut (``pip3 install pandas``)
+* **matplotlib** - For plotting 
\ No newline at end of file