Commits

muzny committed 9db008d

readme updates

Comments (0)

Files changed (1)

 
 ## The Classifier
 
-## The Detector
+## The Detector
+
+## Building
+
+There is an accompanying ant file. From the `WiktionaryIdioms` directory, simply type `ant` or `ant dist` to build the distribution jar.
+
+If you would like the runnable jars corresponding to `classifier.experiments.RunClassifierExperimentFromFiles` and `detector.experiments.RunDetectorExperimentsFromFiles`, these can be built by running the command `ant runnables`, and will be made in your `WiktionaryIdioms/dist/` directory.
+
+Alternatively, the jar files are all available in the [Downloads](https://bitbucket.org/muzny/wiktionaryidioms/downloads) section.
+
+## Running
+
+Most of the classes with main files come with descriptions of all parameters that they need to be passed. Here is a description of two key classes and how to run them.
+
+All main classes will work with 4g of memory allocated. (`-Xmx4g`) Most require at least this much memory.
+
+### _*RunClassifierExperiment*_
+
+## Data
+
+### Eclipse
+
+To work on the project in Eclipse, simply download and import the project WiktionaryIdioms into it.