From 90153fc74c078374eced35cec8f58fcbb19f61b3 Mon Sep 17 00:00:00 2001 From: Gaurav Kumar Date: Tue, 10 Jan 2017 14:33:38 -0500 Subject: [PATCH] Move build instructions to top of documentation It's hard to figure out how the build process works if someone clones this repository. The instructions are currently at the bottom of README.md. This change will move this to the top. --- README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a046f49..e34c7a8 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ Jonathan Clark, Chris Dyer, Alon Lavie, and Noah Smith, "Better Hypothesis Testi To keep updated on new versions of this software, subscribe to our low-traffic announcement mailing list: http://groups.google.com/group/multeval-announce. All active users are encourated to subscribe. -Usage -===== +Download +======== First, download and unpack the program: @@ -20,6 +20,22 @@ wget http://www.cs.cmu.edu/~jhclark/downloads/multeval-0.5.1.tgz tar -xvzf multeval-0.5.1.tgz ``` +Building from source +==================== + +Should you want to build MultEval yourself instead of using the provided tarball distribution, you'll need to download meteor using get_deps.sh. Then you can just run ant: + +``` bash +$ ./get_deps.sh # Download meteor +$ ant +``` + +NOTE: There's a strange generics-related javac bug that's known to cause the build to fail under OpenJDK V1.6.0_17. However, this seems to be resolved as of version 1.6.0_21. + + +Usage +===== + To evaluate a single system from the example data and get its BLEU, METEOR, and TER scores along with its standard deviation use: ``` bash @@ -241,18 +257,6 @@ MultEval uses the following libraries: * Google Guava (Apache License) * Java Annotation Options (jannopts, LGPL License) -Building -======== - -Should you want to build MultEval yourself instead of using the provided tarball distribution, you'll need to download meteor using get_deps.sh. Then you can just run ant: - -``` bash -$ ./get_deps.sh # Download meteor -$ ant -``` - -NOTE: There's a strange generics-related javac bug that's known to cause the build to fail under OpenJDK V1.6.0_17. However, this seems to be resolved as of version 1.6.0_21. - Citation ========