diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/README.rst b/README.rst index 0fb7a66cae..5ffcff22cd 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. @@ -115,6 +120,7 @@ Installing prerequisites on Mac OS X:: xcode-select --install sudo easy_install pip sudo pip install virtualenv + brew install pkg-config libffi Installing prerequisites on Raspbian:: @@ -306,7 +312,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 @@ -789,6 +795,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:: @@ -801,7 +811,7 @@ to install using pip and a virtualenv:: virtualenv env source env/bin/activate python synapse/python_dependencies.py | xargs pip install - pip install setuptools_trial mock + pip install lxml mock This will run a process of downloading and installing all the needed dependencies into a virtual env. @@ -809,7 +819,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:: |