Readme changes

sroy9 · Nov 15, 2016 · 859cda0 · 859cda0
1 parent 717392f
commit 859cda0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -19,4 +19,5 @@ models/
 easyccg*
 giza*
 parallel*
-data/shyam*
+data/shyam*
+*~
diff --git a/README.md b/README.md
@@ -12,13 +12,24 @@ Data can be found in the folder data/equationparsebrat/.
 
 Instructions to run the code :
 
+You will need to have maven installed in your system. To download the 
+dependencies, run
+
+    mvn dependency:copy-dependencies
+        
+Next compile using : 
+
+    mvn compile     
+
+Finally here are the options:
+
 1. sh run.sh Numoccur : Predicts quantity trigger list. Output file log/Numoccur.out
 
 2. sh run.sh Var : Predicts variable trigger list. Output file log/Var.out
 
 3. sh run.sh Tree : Predicts equation tree. Output file log/Tree.out
 
-4. sh run.sh Pipeline : Runs the first three classifiers in a pipeline, and predicts complete equation parse. Output file log/Pipeline.out
+4. sh run.sh Pipeline : Runs the first three classifiers in a pipeline, and predicts complete equation parse. Output file log/Pipeline.out. Assumes steps 1-3 have been already run.
 
 5. sh run.sh : Runs the pipeline method end to end, basically runs steps 1 to 4.