|
|
@@ -0,0 +1,29 @@
|
|
|
+# d20-charsheet
|
|
|
+
|
|
|
+# Building
|
|
|
+This guide assumes the following:
|
|
|
+
|
|
|
+* The directory you download this project to is called 'd20-charsheet'
|
|
|
+* Both java and maven's bin directories are on the PATH
|
|
|
+* The product is named 'd20-charsheet.jar'
|
|
|
+
|
|
|
+## Tools Required
|
|
|
+1. [Java Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
|
|
|
+2. [Maven](https://maven.apache.org/download.cgi)
|
|
|
+
|
|
|
+## Build Steps
|
|
|
+1. Clone/Download this repository
|
|
|
+2. Open a command prompt in d20-charsheet
|
|
|
+3. Enter the command `mvn clean package`
|
|
|
+
|
|
|
+## Running
|
|
|
+From the d20-charsheet directory, run the below command for your OS.
|
|
|
+
|
|
|
+On Windows: `java -jar target\d20-charsheet.jar`
|
|
|
+On OSX/Linux: `java -jar target/d20-charsheet.jar`
|
|
|
+
|
|
|
+**Currently, this can only be run from the 'd20-charsheet' directory!**
|
|
|
+
|
|
|
+# Installing
|
|
|
+
|
|
|
+Not Yet Supported
|
