summary refs log tree commit diff
path: root/synapse_topology/docs/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'synapse_topology/docs/README.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