From 295812dc9be0c931037f37b5cceb18692af7018b Mon Sep 17 00:00:00 2001
From: Maxence Ferrari <maxence.ferrari@lis-lab.fr>
Date: Tue, 6 Jul 2021 10:03:22 +0000
Subject: [PATCH] Update README.md

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a8531e2..517395d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
-Annotation tool for tdoa tracks
+TDOA Annotation for BOMBYX
+==================
 
+`Update get_track_BOMBYX_7.py` is a graphic utility made for the manual annotation of sperm whale tracks.
+
+
+Usage
+-----
+![GUI example](gui_example.png "GUI example")
+
+The GUI is split into two parts.
+
+The top plot shows the TDOA of the clicks detected. Vertical bars separate the temporal regions that have been concatenated together.
+
+Clicking on a point will then display the metadata of this point above the graph and showed the spectrogram of a 10 seconds window around the selected click. Meanwhile, the sound of this windowed signal will be played.
+
+Below the spectrogram are three buttons. Clicking on one will assign the corresponding label to the selected click.
-- 
GitLab