1 files changed, 22 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 31ae5cc578..d872b11f57 100644
--- a/README.rst
+++ b/README.rst
@@ -243,7 +243,7 @@ Then update the ``users`` table in the database::
Synapse Development
===================
-Join our developer community on Matrix: [#synapse-dev:matrix.org](https://matrix.to/#/#synapse-dev:matrix.org)
+Join our developer community on Matrix: `#synapse-dev:matrix.org <https://matrix.to/#/#synapse-dev:matrix.org>`_
Before setting up a development environment for synapse, make sure you have the
system dependencies (such as the python header files) installed - see
@@ -280,6 +280,27 @@ differ)::
PASSED (skips=15, successes=1322)
+We recommend using the demo which starts 3 federated instances running on ports `8080` - `8082`
+
+ ./demo/start.sh
+
+(to stop, you can use `./demo/stop.sh`)
+
+If you just want to start a single instance of the app and run it directly::
+
+ # Create the homeserver.yaml config once
+ python -m synapse.app.homeserver \
+ --server-name my.domain.name \
+ --config-path homeserver.yaml \
+ --generate-config \
+ --report-stats=[yes|no]
+
+ # Start the app
+ python -m synapse.app.homeserver --config-path homeserver.yaml
+
+
+
+
Running the Integration Tests
=============================
|