summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authornjames <nkskjames@gmail.com>2016-09-08 07:49:43 -0500
committernjames <nkskjames@gmail.com>2016-09-08 07:49:43 -0500
commit960e7cd784ac5fe6ab91e3bf49e2d358b5469eb2 (patch)
tree8ca5fe7d82b568c55279ecab553c632d8d92de47 /README.md
parent31baf3afa79051667b50ea7adf50e9017ccbf0a2 (diff)
downloadserverwiz-960e7cd784ac5fe6ab91e3bf49e2d358b5469eb2.tar.gz
serverwiz-960e7cd784ac5fe6ab91e3bf49e2d358b5469eb2.zip
Added README file with build instructions
Signed-off-by: Norman James <nkskjames@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..09e2e9e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Serverwiz #
+
+
+## Building ##
+
+Serverwiz uses an ant build script.
+
+To start a build:
+
+ cd <repodir>
+ ant -f build.xml clean compile jar
+
+The jars are built in the ./build directory.
+
+The OS specific jar can be ran directly. In order to do this, there must be a
+./xml directory from where java is executed that contains the library files.
+So if you are in the repository directory, you can run:
+
+ java -jar build/serverwiz2_[OS].jar
+
+where OS is linux64, macosx64, win32, or win64.
+
+
+serverwiz2.jar is the main launcher jar. This jar checks the OS and downloads
+the proper OS specific jar from the latest github release. It also downloads
+the XML library files. It will not use the jar that was built locally unless using
+the -d flag.
+
+To run:
+
+ java -jar serverwiz2.jar
+
+ \ No newline at end of file
OpenPOWER on IntegriCloud