Oups, some renaming of variables was a bit too brutal. Fixed.

[mtp.git] / README.txt

diff --git a/README.txt b/README.txt
index 870e369..793710b 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,9 +1,35 @@
 
-This is a very simple implementation of the KSP applied to
-multi-target tracking. It is dubbed Multi-Tracked Paths since it
-differs a bit from the standard KSP. It works with negative edge
-length and stops when it can not find any path of negative length,
-instead of fixing the total number of paths to a constant K.
+* INTRODUCTION
+
+This is a very simple implementation of a variant of KSP applied to
+multi-target tracking dubbed "Multi-Tracked Paths" (MTP).
+
+It works with negative edge length and stops when it can not find any
+path of negative total length, instead of fixing the total number of
+paths to a constant K.
+
+* INSTALLATION
+
+This source code should compile with any C++ compiler. Just execute
+
+  make
+  ./mtp_example
+
+It will create a synthetic dummy example, save its description in
+tracker.dat, and print the optimal detected trajectories.
+
+If you now execute
+
+  ./mtp tracker.dat
+
+It will load the tracker.dat example, run the detection, save the
+detected trajectories in result.trj, and the underlying graph with
+occupied edges in graph.dot. You can produce a pdf from the latter
+with the dot command from graphviz:
+
+  dot < graph.dot -T pdf -o graph.pdf
+
+* IMPLEMENTATION
 
 The two main classes are MTPGraph and Tracker.