Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Fixes to the formatting of README.rst (#12627)
Browse files Browse the repository at this point in the history
Fixes a couple of formatting errors which were introduced in #12475.
  • Loading branch information
richvdh authored May 4, 2022
1 parent 96e0cdb commit 873d467
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <https://python-poetry.org/>`_. First, install poetry. We recommend::

| pip install --user pipx
| pipx install poetry
pip install --user pipx
pipx install poetry

as described `here <https://python-poetry.org/docs/#installing-with-pipx>`_.
(See `poetry's installation docs <https://python-poetry.org/docs/#installation>`
(See `poetry's installation docs <https://python-poetry.org/docs/#installation>`_
for other installation methods.) Then ask poetry to create a virtual environment
from the project and install Synapse's dependencies::

Expand All @@ -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 <https://matrix-org.github.io/synapse/develop/development/demo.html>`_
for more information.
Expand Down
1 change: 1 addition & 0 deletions changelog.d/12627.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixes to the formatting of README.rst.

0 comments on commit 873d467

Please sign in to comment.