Browse Source

Updating README.rst (#8746)

Minor corrections and advice... Should help beginners.
tags/v1.23.0rc1
chagai95 3 years ago
committed by GitHub
parent
commit
69147ed158
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 6 deletions
  1. +10
    -6
      README.rst
  2. +1
    -0
      changelog.d/8746.doc

+ 10
- 6
README.rst View File

@@ -261,18 +261,22 @@ to install using pip and a virtualenv::
pip install -e ".[all,test]"

This will run a process of downloading and installing all the needed
dependencies into a virtual env.
dependencies into a virtual env. If any dependencies fail to install,
try installing the failing modules individually::

Once this is done, you may wish to run Synapse's unit tests, to
check that everything is installed as it should be::
pip install -e "module-name"

Once this is done, you may wish to run Synapse's unit tests to
check that everything is installed correctly::

python -m twisted.trial tests

This should end with a 'PASSED' result::
This should end with a 'PASSED' result (note that exact numbers will
differ)::

Ran 1266 tests in 643.930s
Ran 1337 tests in 716.064s

PASSED (skips=15, successes=1251)
PASSED (skips=15, successes=1322)

Running the Integration Tests
=============================


+ 1
- 0
changelog.d/8746.doc View File

@@ -0,0 +1 @@
Add some helpful hints to the README for new Synapse developers. Contributed by @chagai95.

Loading…
Cancel
Save