View source for Matxin linearisation with the statistical text generator


== Prerequisites ==

You will need Apache Ant, the Java Development Kit (JDK), and Java. On Ubuntu or any other Debian-based operating system, you can simply install the <code>ant</code> package from APT, and APT will automatically install Java and the JDK.

== Building ==

Once you have cloned the repository, simply run

<code>$ ant</code>

from its root directory. Ant will automatically compile and jar all the classes.

== Usage ==

We use Ant to run the project's programs. Ant, however, cannot forward command-line arguments to programs on its own, so we use a simple wrapper script.

<code>./run.sh [CLASS] [ARGS]...</code>

<code>CLASS</code> is the name of the main class---that is, the class that contains the <code>main</code> function that you want to execute.