Skip to content

Commit e70b536

Browse files
authored
Add new content to section Contribution in README.md (#44)
1 parent 517f034 commit e70b536

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,31 @@ at your option.
2828
Unless you explicitly state otherwise, any contribution intentionally submitted
2929
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
3030
dual licensed as above, without any additional terms or conditions.
31+
32+
### Run integration tests
33+
34+
Requires `docker` and [`cargo-hack`].
35+
36+
Check [getting Docker guide](https://docs.docker.com/get-docker/) on how to install docker,
37+
and use `cargo install cargo-hack` to install [`cargo-hack`].
38+
39+
```
40+
./run_ci_tests.sh
41+
```
42+
43+
It will create a container which runs sshd, setup ssh-agent, and environment variables
44+
that are required to run the integration tests.
45+
46+
It will also test different combination of feature flags to ensure they all compile without error.
47+
48+
[`cargo-hack`]: https://github.com/taiki-e/cargo-hack
49+
50+
### Build documentation
51+
52+
Requires nightly cargo.
53+
54+
To install nightly cargo, run `rustup toolchain install nightly`.
55+
56+
```
57+
./build_doc.sh
58+
```

0 commit comments

Comments
 (0)