Commit e83f996d authored by Lukas Burgey's avatar Lukas Burgey
Browse files

Update README

parent bdc828b0
......@@ -8,24 +8,20 @@ In order to do so, it needs to be registered at the respective backend instance.
The client is configured using a single config file.
Building
----
To build the client you need go version 1.8 or higher. We recommend using the newest stable version.
- In addition you need to have a GOPATH setup (instructions: ```go help gopath```)
This project is built using go. We make use of go modules which were introduced in go1.11. You can check your go version with ```go version```. We recommend using the latest stable version.
- Fetch the repository and its dependencies into the GOPATH: ```go get -u git.scc.kit.edu/feudal/feudalClient```
- You need to have a GOPATH setup (see ```go help gopath```). As a start you need the GOPATH enviroment variable set to a directory.
- Clone the repository outside of $GOPATH: ```git clone https://git.scc.kit.edu/feudal/feudalClient```
- Build the client: ```go install git.scc.kit.edu/feudal/feudalClient```. The binary will be located at $GOPATH/bin/feudalClient.
- Switch to the cloned directory and run ```go get```. This fetches dependencies and builds the project. The binary will be located at $GOPATH/bin/feudalClient.
Installation
----
Copy the binary and a config file to the target VM.
See example-config for an example config.
See example-config for an example configuration.
- Additional info: ```feudalClient --help```
- Run the client: ```feudalClient ./config/file/path```
\ No newline at end of file
- Run the client: ```feudalClient --config ./config/file/path```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment