From 73f76aa4b5f3fd5cd8b3aef75ea0ddba300a5deb Mon Sep 17 00:00:00 2001 From: hoijui Date: Fri, 8 May 2020 08:16:43 +0200 Subject: [PATCH] README: document the Maven way of doing things --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 251be31..3a83e70 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,27 @@ - Option to update Barnes-Hut tree centers every n iterations - Command line interface -## Installation -Download gephi-toolkit-0.9.2-all.jar and forceatlas2.jar from https://github.com/klarman-cell-observatory/forceatlas2/releases +## Building +```bash +mvn package +``` ## Command Line Usage -``` -java -Djava.awt.headless=true -Xmx8g -cp forceatlas2.jar:gephi-toolkit-0.9.2-all.jar kco.forceatlas2.Main flags -``` +There are two options: + +1. from within the source code project: + + ```bash + mvn exec:java -Djava.awt.headless=true -Xmx8g -Dexec.args="[FLAG]..." + ``` + +2. using the JAR built with `mvn package`: + + ```bash + java -Djava.awt.headless=true -Xmx8g -jar target/forceatlas2-*-jar-with-dependencies.jar [FLAG]... + ``` where flags are