diff options
| author | Andy Balaam <andyb@element.io> | 2022-01-13 16:33:37 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-13 16:33:37 +0000 |
| commit | 5ff5f17377432645f65bc614228783cccb69d20c (patch) | |
| tree | a3d26ef0b622c40a60fc94fbef12c7db74abf29f /docs/development/contributing_guide.md | |
| parent | Include bundled aggregations in the sync response cache. (#11659) (diff) | |
| download | synapse-5ff5f17377432645f65bc614228783cccb69d20c.tar.xz | |
Mention python3-venv and libpq-dev dependencies in contribution guide (#11740)
Diffstat (limited to 'docs/development/contributing_guide.md')
| -rw-r--r-- | docs/development/contributing_guide.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index 121f7c0687..c142981693 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -20,7 +20,9 @@ recommended for development. More information about WSL can be found at <https://docs.microsoft.com/en-us/windows/wsl/install>. Running Synapse natively on Windows is not officially supported. -The code of Synapse is written in Python 3. To do pretty much anything, you'll need [a recent version of Python 3](https://wiki.python.org/moin/BeginnersGuide/Download). +The code of Synapse is written in Python 3. To do pretty much anything, you'll need [a recent version of Python 3](https://www.python.org/downloads/). Your Python also needs support for [virtual environments](https://docs.python.org/3/library/venv.html). This is usually built-in, but some Linux distributions like Debian and Ubuntu split it out into its own package. Running `sudo apt install python3-venv` should be enough. + +Synapse can connect to PostgreSQL via the [psycopg2](https://pypi.org/project/psycopg2/) Python library. Building this library from source requires access to PostgreSQL's C header files. On Debian or Ubuntu Linux, these can be installed with `sudo apt install libpq-dev`. The source code of Synapse is hosted on GitHub. You will also need [a recent version of git](https://github.com/git-guides/install-git). |