diff --git a/README.md b/README.md index 1983a34..ce98ac9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ # JobServ Remote Procedure Calls over the protobuf API -# Dependancies - # Building +Gradle will manage dependencies, generate code, compile the java, and package the code. +Simply run the folllowing command: +```shell +$ gradle clean build +``` +Gradle will package both the client and server into both a zip and a tarball. +The tarball is located in build/distributions. After extracting one of the archives on a target machine the following commands will run JobServ. +Make sure you are in the directory you extracted the archive to. +```shell +$ ./bin/jobserv-server +$ ./bin/jobserv-client (host) (port) +``` +(TODO: seperate archives for client and server) # Testing - -# Running +(TODO: tests for mtls, job control module)