From 69147ed15897f66838ed4224048dda606cb529e2 Mon Sep 17 00:00:00 2001 From: chagai95 <31655082+chagai95@users.noreply.github.com> Date: Fri, 13 Nov 2020 13:07:09 +0100 Subject: Updating README.rst (#8746) Minor corrections and advice... Should help beginners. --- README.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 59d5a4389b..d724cf97da 100644 --- a/README.rst +++ b/README.rst @@ -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 ============================= -- cgit 1.4.1