Skip to content

Commit

Permalink
README.md: document how to develop and install
Browse files Browse the repository at this point in the history
  • Loading branch information
bassosimone committed Jun 19, 2019
1 parent f900c9f commit d2d1286
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,38 @@ Reference ndt7 Go client implementation. Useful resources:

The master branch contains stable code. We don't promise we won't break
the API, but we'll try not to.

## Installing

You need Go >= 1.11. We use modules. Make sure that (1) there is
no `GOPATH` and (2) Go < 1.13 uses modules by default. To do
that, do the following in your shell:

```bash
unset GOPATH # 1.
export GO111MODULE=on # 2.
```

### Cloning the sources and developing

Make sure you environment is correctly set as explained above. To clone
the sources in the current working directory, run:

```bash
git clone https://github.com/m-lab/ndt7-client-go
```

Then you can enter the directory and do usual Go development.

### Compiling the ndt7-client command on the fly

Make sure you environment is correctly set as explained above. Then
compile on the fly the ndt7-client command with:


```bash
go get -v github.com/m-lab/ndt7-client-go/cmd/ndt7-client
```

This will compile the `ndt7-client` binary and install it into
the `$HOME/go/bin` directory.

0 comments on commit d2d1286

Please sign in to comment.