Skip to content

Commit 63902df

Browse files
Add docs for getting started writing your own Complement tests (#70)
1 parent 9a4ff41 commit 63902df

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
1+
[![Complement Dev](https://img.shields.io/matrix/complement:matrix.org.svg?label=%23complement%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#complement:matrix.org)
2+
13
### Complement
24

35
Complement is a black box integration testing framework for Matrix homeservers.
46

7+
8+
#### Getting started
9+
10+
To get started developing, see https://github.com/matrix-org/complement/blob/master/ONBOARDING.md
11+
12+
If you're looking to run Complement against a local dev instance of Synapse, see [`matrix-org/synapse` -> `scripts-dev/complement.sh`](https://github.com/matrix-org/synapse/blob/develop/scripts-dev/complement.sh).
13+
14+
If you want to develop Complement tests while working on a local dev instance of Synapse, edit [`scripts-dev/complement.sh`](https://github.com/matrix-org/synapse/blob/develop/scripts-dev/complement.sh) to point to your local Complement checkout (`cd ../complement`) instead of downloading from GitHub.
15+
16+
517
#### Running
618

719
You need to have Go and Docker installed. Then:

0 commit comments

Comments
 (0)