From 673d085913fdcf58f0d442d54fd252a193a7d26c Mon Sep 17 00:00:00 2001 From: squahtx Date: Fri, 29 Oct 2021 13:04:28 +0000 Subject: deploy: 3ed17ff651a39d64288c38cd56ecef3603a31d04 --- develop/development/contributing_guide.html | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'develop/development/contributing_guide.html') diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index d1c5d23740..de35587e8a 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -194,6 +194,10 @@ license the code under the same terms as the project's overall 'outbound' license - in our case, this is almost always Apache Software License v2 (see LICENSE).

2. What do I need?

+

If you are running Windows, the Windows Subsystem for Linux (WSL) is strongly +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.

The source code of Synapse is hosted on GitHub. You will also need a recent version of git.

For some tests, you will need a recent version of Docker.

@@ -208,7 +212,6 @@ git checkout develop

If you need help getting started with git, this is beyond the scope of the document, but you can find many good git tutorials on the web.

4. Install the dependencies

-

Under Unix (macOS, Linux, BSD, ...)

Once you have installed Python 3 and added the source, please open a terminal and setup a virtualenv, as follows:

cd path/where/you/have/cloned/the/repository
@@ -218,8 +221,6 @@ pip install -e ".[all,dev]"
 pip install tox

This will install the developer dependencies for the project.

-

Under Windows

-

TBD

5. Get in touch.

Join our developer community on Matrix: #synapse-dev:matrix.org!

6. Pick an issue.

-- cgit 1.5.1