From: Francois Fleuret <francois@fleuret.org>
Date: Tue, 25 Dec 2012 10:24:25 +0000 (+0100)
Subject: Added the descriptions of the individual commands.
X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mtp.git;a=commitdiff_plain;h=9d07ad0ca713eaa08b2dd0f119fc4c8a078070ac

Added the descriptions of the individual commands.
---

diff --git a/README.txt b/README.txt
index 894f59d..ba8e593 100644
--- a/README.txt
+++ b/README.txt
@@ -17,6 +17,22 @@ This implementation is not the reference implementation used for the
 experiments presented in this article. It uses a Dijkstra with a
 Binary Heap for the min-queue, and not the optimal Fibonacci heap.
 
+This software package includes three commands:
+
+ - mtp is the generic command to use in practice. It takes tracking
+   parameters as input, and prints the tracked trajectories as
+   output. The format for these parameters is given at the bottom of
+   this documentation.
+
+ - mtp_example creates a tracking toy example, and runs the tracking
+   algorithm on it. It gives an example of how to use MTPTracker on a
+   configuration produced dynamically, and produce a test input file
+   for the mtp command.
+
+ - mtp_stress_test creates a larger problem with a lot of noise and
+   multiple trajectories, to check the behavior of the code under
+   slightly more complex situation.
+
 * INSTALLATION
 
 This software should compile with any C++ compiler. Under a unix-like