Skip to content

Commit 00c1e21

Browse files
committed
Update README.md
1 parent 904f7f2 commit 00c1e21

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,31 @@
66
# ssl-quality-inspector
77
Command line utility to inspect several metrics like network latency and ssl-vision detection
88

9-
## Requirements
10-
You need to install following dependencies first:
11-
* Go >= 1.11
12-
13-
## Installation
9+
### Requirements
1410

15-
Use go get to install all packages / executables:
11+
You need to install following dependencies first:
1612

17-
```
18-
go get -u github.com/RoboCup-SSL/ssl-quality-inspector/...
19-
```
13+
* Go
2014

21-
## Run
22-
The executables are installed to your $GOPATH/bin folder. If you have it on your $PATH, you can directly run them.
23-
Else, switch to this folder first.
15+
See [.circleci/config.yml](.circleci/config.yml) for compatible versions.
2416

25-
The quality inspector can be run by:
17+
### Build
18+
Build and install all binaries:
19+
20+
```shell
21+
make install
2622
```
27-
ssl-quality-inspector
23+
24+
### Run
25+
Build and run main binary:
26+
27+
```shell
28+
make run
2829
```
2930

30-
Available parameters can be retrieved with the `-h` option.
31+
### Update generated protobuf code
32+
Generate the code for the `.proto` files after you've changed anything in a `.proto` file with:
33+
34+
```shell
35+
make proto
36+
```

0 commit comments

Comments
 (0)