Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Clarify lack of Windows support in documentation #11198

Merged
merged 2 commits into from
Oct 29, 2021
Merged

Clarify lack of Windows support in documentation #11198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe6eef5
Clarify lack of Windows support in documentation
Oct 27, 2021
a718b38
Don't mention Windows Server in development instructions
Oct 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/11198.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify lack of support for Windows.
11 changes: 5 additions & 6 deletions docs/development/contributing_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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:

Expand All @@ -56,10 +59,6 @@ pip install tox

This will install the developer dependencies for the project.

## Under Windows

TBD


# 5. Get in touch.

Expand Down
14 changes: 8 additions & 6 deletions docs/setup/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,12 +356,14 @@ make install

##### Windows

If you wish to run or develop Synapse on Windows, the Windows Subsystem For
Linux provides a Linux environment on Windows 10 which is capable of using the
Debian, Fedora, or source installation methods. More information about WSL can
be found at <https://docs.microsoft.com/en-us/windows/wsl/install-win10> for
Windows 10 and <https://docs.microsoft.com/en-us/windows/wsl/install-on-server>
for Windows Server.
Running Synapse natively on Windows is not officially supported.

If you wish to run or develop Synapse on Windows, the Windows Subsystem for
Linux provides a Linux environment which is capable of using the Debian, Fedora,
or source installation methods. More information about WSL can be found at
<https://docs.microsoft.com/en-us/windows/wsl/install> for Windows 10/11 and
<https://docs.microsoft.com/en-us/windows/wsl/install-on-server> for
Windows Server.

## Setting up Synapse

Expand Down