diff options
author | Andrew Conrad <aconrad103@gmail.com> | 2017-11-14 15:09:50 -0600 |
---|---|---|
committer | Andrew Conrad <aconrad103@gmail.com> | 2017-11-14 15:11:35 -0600 |
commit | 053ecae4db7c51c7fa3d56f5ea2b1289d73fa10d (patch) | |
tree | 69a3e34681c59ebfb60ad65a589c7dff90589ad5 /README.rst | |
parent | Merge pull request #2598 from matrix-org/revert-2596-erikj/attestation_jitter (diff) | |
download | synapse-053ecae4db7c51c7fa3d56f5ea2b1289d73fa10d.tar.xz |
Mention SyTest in the README, after Development
Signed-off-by: Andrew Conrad <aconrad103@gmail.com>
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/README.rst b/README.rst index 9da8c7f7a8..cda0794e56 100644 --- a/README.rst +++ b/README.rst @@ -883,6 +883,17 @@ This should end with a 'PASSED' result:: PASSED (successes=143) +Running the Integration Tests +============================= + +Synapse is accompanied by `SyTest <https://github.com/matrix-org/sytest>`_, +a Matrix homeserver integration testing suite, which uses HTTP requests to +access the API as a Matrix client would. It is able to run Synapse directly from +the source tree, so installation of the server is not required. + +Testing with SyTest is recommended for verifying that changes related to the +Client-Server API are functioning correctly. See the `installation instructions +<https://github.com/matrix-org/sytest#installing>`_ for details. Building Internal API Documentation =================================== |