From b9616e661a27dde6b9eb62856226b1accd31908a Mon Sep 17 00:00:00 2001 From: Will Hawkins Date: Wed, 16 Mar 2022 21:02:49 -0400 Subject: Bugfix: Update README.md to include instructions for modules. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5ca9559..bcbec21 100644 --- a/README.md +++ b/README.md @@ -33,14 +33,18 @@ For the remainder of the instructions, we will assume that `${RSPVNSS_SOURCE_DIR ### Build -From `${RSPVNSS_SOURCE_DIR}`, +From `${RSPVNSS_SOURCE_DIR}` grab all the required modules: +``` +$ go mod download +``` + +And then build: ``` $ go build networkQuality.go ``` That will create an executable in `${RSPVNSS_SOURCE_DIR}` named `networkQuality`. - ### Run From `${RSPVNSS_SOURCE_DIR}`, running the client is straightforward. Simply @@ -55,7 +59,7 @@ Without any options, the tool will attempt to contact `networkquality.example.co $./networkQuality --help ``` -`networkQuality` with the `--help` option will generate the following output: +`networkQuality` with the `-help` option will generate the following output: ``` -config string -- cgit v1.2.3