diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2016-12-12 11:17:06 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-12-12 11:17:06 +0000 |
| commit | 62e6d40b3999a7f6488dcbc134a8b8ec1381c436 (patch) | |
| tree | 4d1fa9fc873bfc48eebcfef007bbb7593de361e9 | |
| parent | README: fix link (diff) | |
| parent | fix pythonpath (diff) | |
| download | synapse-62e6d40b3999a7f6488dcbc134a8b8ec1381c436.tar.xz | |
Merge pull request #1685 from matrix-org/rav/update_readme_for_tests
Update the readme to use trial
| -rw-r--r-- | README.rst | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/README.rst b/README.rst index 6a22399e19..8925e7c49d 100644 --- a/README.rst +++ b/README.rst @@ -88,7 +88,12 @@ System requirements: - Python 2.7 - At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org -Synapse is written in python but some of the libraries is uses are written in +Installing from source +---------------------- +(Prebuilt packages are available for some platforms - see `Platform-Specific +Instructions`_.) + +Synapse is written in python but some of the libraries it uses are written in C. So before we can install synapse itself we need a working C compiler and the header files for python C extensions. @@ -302,7 +307,7 @@ See https://github.com/vector-im/vector-web/issues/1977 and https://developer.github.com/changes/2014-04-25-user-content-security for more details. -Platform Specific Instructions +Platform-Specific Instructions ============================== Debian @@ -759,6 +764,10 @@ Then update the `users` table in the database:: Synapse Development =================== +Before setting up a development environment for synapse, make sure you have the +system dependencies (such as the python header files) installed - see +`Installing from source`_. + To check out a synapse for development, clone the git repo into a working directory of your choice:: @@ -770,8 +779,8 @@ to install using pip and a virtualenv:: virtualenv env source env/bin/activate - python synapse/python_dependencies.py | xargs -n1 pip install - pip install setuptools_trial mock + python synapse/python_dependencies.py | xargs pip install + pip install lxml mock This will run a process of downloading and installing all the needed dependencies into a virtual env. @@ -779,7 +788,7 @@ dependencies into a virtual env. Once this is done, you may wish to run Synapse's unit tests, to check that everything is installed as it should be:: - python setup.py test + PYTHONPATH="." trial tests This should end with a 'PASSED' result:: |