mirror of
https://github.com/element-hq/synapse.git
synced 2024-11-24 18:45:52 +03:00
Fixes to the formatting of README.rst (#12627)
Fixes a couple of formatting errors which were introduced in #12475.
This commit is contained in:
parent
96e0cdbc5a
commit
873d467976
2 changed files with 8 additions and 7 deletions
12
README.rst
12
README.rst
|
@ -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::
|
||||
|
||||
|
@ -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.
|
||||
|
|
1
changelog.d/12627.doc
Normal file
1
changelog.d/12627.doc
Normal file
|
@ -0,0 +1 @@
|
|||
Fixes to the formatting of README.rst.
|
Loading…
Reference in a new issue