diff --git a/README.md b/README.md index 70c65a1..440ce3f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # DominionSim -There is a pom.xml which you'll need because there are some dependencies on jars (eg jfreechart). + +DominionSim is a simulator for the Dominion card game. + +## Prerequisites + +You will need the following to build and run the simulator: +- Java SE SDK 1.8+: http://www.oracle.com/technetwork/java/javase/downloads +- Maven: https://maven.apache.org/download.cgi + +## Build + +To build the simulator JAR file: +``` +$ mvn package +``` + +## Run + +To run the simulator: +``` +$ mvn exec:java +``` diff --git a/pom.xml b/pom.xml index 15a637a..3fc824d 100644 --- a/pom.xml +++ b/pom.xml @@ -27,6 +27,16 @@ + + + org.codehaus.mojo + exec-maven-plugin + + be.aga.dominionSimulator.DomEngine + + + + ${basedir}/src/main/java @@ -39,4 +49,4 @@ - \ No newline at end of file +