Update build and test instructions

This commit is contained in:
Brendan Abolivier 2019-05-22 09:59:37 +01:00
parent ba4d45a7c3
commit c8a575b9d6

View file

@ -12,10 +12,11 @@ See [INSTALL.md](INSTALL.md) for instructions on setting up a running dev
instance of dendrite, and [CODE_STYLE.md](CODE_STYLE.md) for the code style instance of dendrite, and [CODE_STYLE.md](CODE_STYLE.md) for the code style
guide. guide.
We use `gb` for managing our dependencies, so `gb build` and `gb test` is how As of May 2019, we're not using `gb` anymore, which is the tool we had been
to build dendrite and run the unit tests respectively. Be aware that a list of using for managing our dependencies, and switched to Go modules. To build
all dendrite packages is the expected output for all tests succeeding with `gb Dendrite, run the `build.sh` script at the root of this repository, and to run
test`. There are also [scripts](scripts) for [linting](scripts/find-lint.sh) unit tests, run `go test ./...` (which should pick up any unit test and run
them). There are also [scripts](scripts) for [linting](scripts/find-lint.sh)
and doing a [build/test/lint run](scripts/build-test-lint.sh). and doing a [build/test/lint run](scripts/build-test-lint.sh).
@ -57,4 +58,3 @@ For more general questions please use [#dendrite:matrix.org](https://matrix.to/#
We ask that everyone who contributes to the project signs off their We ask that everyone who contributes to the project signs off their
contributions, in accordance with the [DCO](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#sign-off). contributions, in accordance with the [DCO](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#sign-off).