Simplifying + cosmetics.
[mtp.git] / README.txt
index 870e369..e814024 100644 (file)
@@ -1,9 +1,24 @@
 
-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 run "make"
+and execute the mtp executable. It should print the optimal detected
+trajectories, and save into graph.dot the result graph and
+trajectories in the dot syntax. You can produce a pdf from the latter
+with
+
+  dot < graph.dot -T pdf -o graph.pdf
+
+* DESCRIPTION
 
 The two main classes are MTPGraph and Tracker.