Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #26

Merged
merged 2 commits into from
Feb 1, 2021
Merged

Improve readme #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b45eb7
Improve readme
claucece Feb 1, 2021
979153b
Update README.md
chris-wood Feb 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ Runner](https://github.com/marten-seemann/quic-interop-runner).

## Quickstart

You will need to have golang installed.

You will need to clone this repository on the `src` directory of your
`$GOPATH`. To learn your `$GOPATH`, use `go env`.

Tests are run with `docker-compose`. To run a test, you must first build the
endpoints. For example, to build a boringSSL server and Cloudflare-Go client:

Expand All @@ -19,14 +24,18 @@ env SERVER_SRC=./impl-endpoints SERVER=boringssl \
```

Tests require certificates and other cryptographic artifacts to be generated
beforehand. To do so, you will need to have Go installed and make sure this
repository is in your $GOPATH (e.g.,
~/go/src/github.com/xvzcf/tls-interop-runner).
beforehand.

```
make testdata
```

This command will generate:
* A root certificate
* Intermediate certificates
* A delegated credential
* ECH configuration files

You're now ready to run tests. The test case is also specified by setting an
environment variable. For example, to run the server-side delegated credential
test:
Expand Down