mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-15 10:53:09 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs adapted that go mod is used

Browse source 
Signed-off-by: Benedikt Bongartz <benne@klimlive.de>
This commit is contained in:
Benedikt Bongartz 2019-05-18 02:24:09 +02:00
parent 9fd1cd7a37
commit 06bda20094
No known key found for this signature in database
GPG key ID: 42342EC23A8A4314
2 changed files with 10 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md
View file

@ -12,9 +12,9 @@ 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
guide.
We use `gb` for managing our dependencies, so `gb build` and `gb test` is how
We use `go mod` for managing our dependencies, so `go build` and `go test` is how
to build dendrite and run the unit tests respectively. Be aware that a list of
all dendrite packages is the expected output for all tests succeeding with `gb
all dendrite packages is the expected output for all tests succeeding with `go
test`. There are also [scripts](scripts) for [linting](scripts/find-lint.sh)
and doing a [build/test/lint run](scripts/build-test-lint.sh).
@ -35,15 +35,15 @@ issues so that there is always a way for new people to come and get involved.
## Contributing to dependencies
Dependencies are located in `vendor/src` and are managed by `gb`. If you need
Dependencies are located in `vendor` and are managed by `go mod`. If you need
to make some changes in those directories, you first need to open a PR in the
dependency repository. Once your PR is merged, you need to run `gb vendor
update $repo_url` (example: `gb vendor update github.com/matrix-org/gomatrix`)
dependency repository. Once your PR is merged, you need to run `go get -u -v
$repo_url` (example: `go get -u -v github.com/matrix-org/gomatrix`)
in the dendrite repository to update the dependency.
You can then create a commit containing only the modified vendor files (along
with the `vendor/manifest` file), name it with the command you just ran (ie
`gb vendor update github.com/matrix-org/gomatrix`), and open a PR on Dendrite.
with the `go.mod` and `go.sum` file), name it with the command you just ran
(ie `go get -u -v`), and open a PR on Dendrite.
## Getting Help
@ -57,4 +57,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
contributions, in accordance with the [DCO](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#sign-off).

6
INSTALL.md
View file

@ -12,7 +12,7 @@ Dendrite can be run in one of two configurations:
## Requirements
- Go 1.10+
- Go 1.11+
- Postgres 9.5+
- For Kafka (optional if using the monolith server):
- Unix-based system (https://kafka.apache.org/documentation/#os)
@ -28,10 +28,6 @@ Assumes Go 1.10+ and JDK 1.8+ are already installed and are on PATH.
# Get the code
git clone https://github.com/matrix-org/dendrite
cd dendrite
# Build it
go get github.com/constabulary/gb/...
gb build
```
If using Kafka, install and start it (c.f. [scripts/install-local-kafka.sh](scripts/install-local-kafka.sh)):