summary refs log tree commit diff
diff options
context:
space:
mode:
authorJorik Schellekens <joriks@matrix.org>2019-08-08 14:18:09 +0100
committerJorik Schellekens <joriks@matrix.org>2019-08-28 15:59:53 +0100
commit39641482ef6a7eeaae0960d0f3ac724e2cf5eacc (patch)
treeeb6f34ddd4ddfe2f10c7cf73dde8ecdb4cf5d1d4
parentHandle relative paths correctly! (diff)
downloadsynapse-39641482ef6a7eeaae0960d0f3ac724e2cf5eacc.tar.xz
My reflex is to write markdown. I forgot this was RST
-rw-r--r--synapse_topology/docs/README.rst21
1 files changed, 13 insertions, 8 deletions
diff --git a/synapse_topology/docs/README.rst b/synapse_topology/docs/README.rst
index f6d484bfae..fa10aa0605 100644
--- a/synapse_topology/docs/README.rst
+++ b/synapse_topology/docs/README.rst
@@ -1,11 +1,16 @@
-# Backend
-Windows: Right click __init__.py and select run with python
-*nix: ./__init__.py
+Backend
+=======
+::
 
-# Frontend:
+  Make sure you have synapse and klein installed in your pip env
+  Windows Right click __init__.py and select run with python
+  *nix: ./__init__.py
+
+Frontend
+========
 Start the Backend and
 
-```
-cd view/webui
-yarn watch
-```
+.. code:: bash
+
+  cd view/webui
+  yarn watch