readme has instructions for building and running
This commit is contained in:
parent
2497f848c4
commit
185b686ad1
1 changed files with 14 additions and 4 deletions
18
README.md
18
README.md
|
|
@ -1,10 +1,20 @@
|
||||||
# JobServ
|
# JobServ
|
||||||
Remote Procedure Calls over the protobuf API
|
Remote Procedure Calls over the protobuf API
|
||||||
|
|
||||||
# Dependancies
|
|
||||||
|
|
||||||
# Building
|
# 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
|
# Testing
|
||||||
|
(TODO: tests for mtls, job control module)
|
||||||
# Running
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue