mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-14 11:57:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fixes to the formatting of README.rst (#12627)

Browse source 
Fixes a couple of formatting errors which were introduced in #12475.
This commit is contained in:
Richard van der Hoff 2022-05-04 11:02:19 +01:00 committed by GitHub
parent 96e0cdbc5a
commit 873d467976
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.rst
View file

@ -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 generation of fully open and interoperable messaging and VoIP apps for the
internet. 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. team, written in Python 3/Twisted.
In Matrix, every user runs one or more Matrix clients, which connect through to In Matrix, every user runs one or more Matrix clients, which connect through to
@ -294,13 +294,13 @@ directory of your choice::
cd synapse cd synapse
Synapse has a number of external dependencies. We maintain a fixed development 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 pip install --user pipx
| pipx install poetry pipx install poetry
as described `here <https://python-poetry.org/docs/#installing-with-pipx>`_. 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 for other installation methods.) Then ask poetry to create a virtual environment
from the project and install Synapse's dependencies:: 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 This will run a process of downloading and installing all the needed
dependencies into a virtual env. 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 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>`_ See the `demo documentation <https://matrix-org.github.io/synapse/develop/development/demo.html>`_
for more information. for more information.

1
changelog.d/12627.doc Normal file
View file

@ -0,0 +1 @@
Fixes to the formatting of README.rst.