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

Updating README.rst #8746

Merged
merged 3 commits into from
Nov 13, 2020
Merged

Updating README.rst #8746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de0a3c3
Update README.rst
chagai95 Nov 12, 2020
af7172e
Some minor wording changes
anoadragon453 Nov 13, 2020
c173b57
Add changelog
anoadragon453 Nov 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=============================
Expand Down
1 change: 1 addition & 0 deletions changelog.d/8746.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add some helpful hints to the README for new Synapse developers. Contributed by @chagai95.