mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-28 15:08:49 +03:00
Code Issues Projects Releases Packages Wiki Activity

Updating README.rst (#8746)

Browse source 
Minor corrections and advice... Should help beginners.
This commit is contained in:
chagai95 2020-11-13 13:07:09 +01:00 committed by GitHub
parent 427ede619f
commit 69147ed158
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.rst
View file

@ -261,18 +261,22 @@ to install using pip and a virtualenv::
pip install -e ".[all,test]" pip install -e ".[all,test]"
This will run a process of downloading and installing all the needed 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 pip install -e "module-name"
check that everything is installed as it should be::
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 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 Running the Integration Tests
============================= =============================

1
changelog.d/8746.doc Normal file
View file

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