1 files changed, 20 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index b3b2a94dbf..8c4ebd52d4 100644
--- a/README.rst
+++ b/README.rst
@@ -53,7 +53,7 @@ To get up and running:
config file: ``./synctl start`` will give you instructions on how to do this.
For this purpose, you can use 'localhost' or your hostname as a server name.
Once you've done so, running ``./synctl start`` again will start your private
- home sserver. You will find a webclient running at http://localhost:8008.
+ home server. You will find a webclient running at http://localhost:8008.
Please use a recent Chrome or Firefox for now (or Safari if you don't need
VoIP support).
@@ -131,17 +131,20 @@ header files for python C extensions.
Installing prerequisites on Ubuntu::
- $ sudo apt-get install build-essential python2.7-dev libffi-dev
+ $ sudo apt-get install build-essential python2.7-dev libffi-dev \
+ python-pip python-setuptools
Installing prerequisites on Mac OS X::
$ xcode-select --install
-Synapse uses NaCl (http://nacl.cr.yp.to/) for encryption and digital
-signatures. Unfortunately PyNACL currently has a few issues
+Synapse uses NaCl (http://nacl.cr.yp.to/) for encryption and digital signatures.
+Unfortunately PyNACL currently has a few issues
(https://github.com/pyca/pynacl/issues/53) and
(https://github.com/pyca/pynacl/issues/79) that mean it may not install
-correctly. To fix try re-installing from PyPI or directly from (https://github.com/pyca/pynacl)::
+correctly, causing all tests to fail with errors about missing "sodium.h". To
+fix try re-installing from PyPI or directly from
+(https://github.com/pyca/pynacl)::
$ # Install from PyPI
$ pip install --user --upgrade --force pynacl
@@ -158,9 +161,21 @@ To install the synapse homeserver run::
This installs synapse, along with the libraries it uses, into
``$HOME/.local/lib/``.
+To actually run your new homeserver, pick a working directory for Synapse to run (e.g. ``~/.synapse``), and::
+
+ $ mkdir ~/.synapse
+ $ cd ~/.synapse
+ $ synctl start
+
Homeserver Development
======================
+To check out a homeserver for development, clone the git repo into a working
+directory of your choice:
+
+ $ git clone https://github.com/matrix-org/synapse.git
+ $ cd synapse
+
The homeserver has a number of external dependencies, that are easiest
to install by making setup.py do so, in --user mode::
|
