JAL-2622 Tidied up gitignore, added to README

[jalview.git] / benchmarking / README

diff --git a/benchmarking/README b/benchmarking/README
index 63381ce..b30920e 100644 (file)
--- a/benchmarking/README
+++ b/benchmarking/README
@@ -7,12 +7,17 @@ This builds a jalview.jar file and puts it into dist/
 
 2. Make a lib directory in benchmarking/ if not already present.
 
-3. Run
+3. Purge any previous maven dependencies:
+   mvn dependency:purge-local-repository -DactTransitively=false -DreResolve=false
+
+4. Run
   mvn install:install-file -Dfile=../dist/jalview.jar -DgroupId=jalview.org -DartifactId=jalview -Dversion=1.0 -Dpackaging=jar -DlocalRepositoryPath=lib
 
 to install the jalview.jar file in the local maven repository. The pom.xml in the benchmarking references this installation, so if you change the names the pom.xml file will also need to be updated.
 
-4. Build and run jmh benchmarking. In the benchmarking directory:
+5. Build and run jmh benchmarking. In the benchmarking directory:
   mvn clean install
   java -jar target/benchmarks.jar
-  
\ No newline at end of file
+  
+  To get JSON output instead use:
+  java -jar target/benchmarks.jar -rf json
\ No newline at end of file