Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 69147ed

Browse files
authored
Updating README.rst (#8746)
Minor corrections and advice... Should help beginners.
1 parent 427ede6 commit 69147ed

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -261,18 +261,22 @@ to install using pip and a virtualenv::
261261
pip install -e ".[all,test]"
262262

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

266-
Once this is done, you may wish to run Synapse's unit tests, to
267-
check that everything is installed as it should be::
267+
pip install -e "module-name"
268+
269+
Once this is done, you may wish to run Synapse's unit tests to
270+
check that everything is installed correctly::
268271

269272
python -m twisted.trial tests
270273

271-
This should end with a 'PASSED' result::
274+
This should end with a 'PASSED' result (note that exact numbers will
275+
differ)::
272276

273-
Ran 1266 tests in 643.930s
277+
Ran 1337 tests in 716.064s
274278

275-
PASSED (skips=15, successes=1251)
279+
PASSED (skips=15, successes=1322)
276280

277281
Running the Integration Tests
278282
=============================

changelog.d/8746.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add some helpful hints to the README for new Synapse developers. Contributed by @chagai95.

0 commit comments

Comments
 (0)