From 185b686ad1867fbdd684e9a6859e283e70c81534 Mon Sep 17 00:00:00 2001 From: Aidan Hahn Date: Fri, 17 May 2019 12:28:22 -0700 Subject: [PATCH] readme has instructions for building and running --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) 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)