From 873d467976fef7a58e54b033ee114849d547c793 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Wed, 4 May 2022 11:02:19 +0100 Subject: [PATCH] Fixes to the formatting of README.rst (#12627) Fixes a couple of formatting errors which were introduced in #12475. --- README.rst | 14 +++++++------- changelog.d/12627.doc | 1 + 2 files changed, 8 insertions(+), 7 deletions(-) create mode 100644 changelog.d/12627.doc diff --git a/README.rst b/README.rst index 80201d4eb1..219e32de8e 100644 --- a/README.rst +++ b/README.rst @@ -55,7 +55,7 @@ solutions. The hope is for Matrix to act as the building blocks for a new generation of fully open and interoperable messaging and VoIP apps for the internet. -Synapse is a Matrix "homeserver" implementation developed by the matrix.org core +Synapse is a Matrix "homeserver" implementation developed by the matrix.org core team, written in Python 3/Twisted. In Matrix, every user runs one or more Matrix clients, which connect through to @@ -294,13 +294,13 @@ directory of your choice:: cd synapse Synapse has a number of external dependencies. We maintain a fixed development -environment using [poetry](https://python-poetry.org/). First, install poetry. We recommend +environment using `Poetry `_. First, install poetry. We recommend:: - | pip install --user pipx - | pipx install poetry + pip install --user pipx + pipx install poetry as described `here `_. -(See `poetry's installation docs ` +(See `poetry's installation docs `_ for other installation methods.) Then ask poetry to create a virtual environment from the project and install Synapse's dependencies:: @@ -309,11 +309,11 @@ from the project and install Synapse's dependencies:: This will run a process of downloading and installing all the needed dependencies into a virtual env. -We recommend using the demo which starts 3 federated instances running on ports `8080` - `8082` +We recommend using the demo which starts 3 federated instances running on ports `8080` - `8082`:: poetry run ./demo/start.sh -(to stop, you can use `poetry run ./demo/stop.sh`) +(to stop, you can use ``poetry run ./demo/stop.sh``) See the `demo documentation `_ for more information. diff --git a/changelog.d/12627.doc b/changelog.d/12627.doc new file mode 100644 index 0000000000..3a787dfef2 --- /dev/null +++ b/changelog.d/12627.doc @@ -0,0 +1 @@ +Fixes to the formatting of README.rst.