Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
g3force committed Apr 23, 2023
1 parent 904f7f2 commit 00c1e21
Showing 1 changed file with 21 additions and 15 deletions.
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,31 @@
# ssl-quality-inspector
Command line utility to inspect several metrics like network latency and ssl-vision detection

## Requirements
You need to install following dependencies first:
* Go >= 1.11

## Installation
### Requirements

Use go get to install all packages / executables:
You need to install following dependencies first:

```
go get -u github.com/RoboCup-SSL/ssl-quality-inspector/...
```
* Go

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

The quality inspector can be run by:
### Build
Build and install all binaries:

```shell
make install
```
ssl-quality-inspector

### Run
Build and run main binary:

```shell
make run
```

Available parameters can be retrieved with the `-h` option.
### Update generated protobuf code
Generate the code for the `.proto` files after you've changed anything in a `.proto` file with:

```shell
make proto
```

0 comments on commit 00c1e21

Please sign in to comment.