summary refs log tree commit diff
path: root/docs/development/contributing_guide.md
diff options
context:
space:
mode:
authorEric Eastwood <erice@element.io>2021-11-03 02:10:07 -0500
committerEric Eastwood <erice@element.io>2021-11-03 02:10:07 -0500
commitec35be57e056a795f7ebe393c81ffcb5bccd5872 (patch)
tree5a592e56da1016f180e1097bee20f03425b74539 /docs/development/contributing_guide.md
parentFix lints (diff)
parentAdd index to `local_group_updates.stream_id` (#11231) (diff)
downloadsynapse-ec35be57e056a795f7ebe393c81ffcb5bccd5872.tar.xz
Merge branch 'develop' into madlittlemods/return-historical-events-in-order-from-backfill
Conflicts:
	scripts-dev/complement.sh
	synapse/handlers/federation_event.py
	synapse/handlers/message.py
	synapse/storage/databases/main/event_federation.py
Diffstat (limited to 'docs/development/contributing_guide.md')
-rw-r--r--docs/development/contributing_guide.md11
1 files changed, 5 insertions, 6 deletions
diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md

index 3bf08a72bb..abdb808438 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md
@@ -15,6 +15,11 @@ license - in our case, this is almost always Apache Software License v2 (see # 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](https://wiki.python.org/moin/BeginnersGuide/Download). 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). @@ -41,8 +46,6 @@ 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: @@ -56,10 +59,6 @@ pip install tox This will install the developer dependencies for the project. -## Under Windows - -TBD - # 5. Get in touch.