mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-09-07 15:21:56 +00:00
Clarify lack of Windows support in documentation (#11198)
This commit is contained in:
parent
56e281bf6c
commit
3ed17ff651
1
changelog.d/11198.doc
Normal file
1
changelog.d/11198.doc
Normal file
@ -0,0 +1 @@
|
|||||||
|
Clarify lack of support for Windows.
|
@ -15,6 +15,11 @@ license - in our case, this is almost always Apache Software License v2 (see
|
|||||||
|
|
||||||
# 2. What do I need?
|
# 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 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).
|
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
|
# 4. Install the dependencies
|
||||||
|
|
||||||
## Under Unix (macOS, Linux, BSD, ...)
|
|
||||||
|
|
||||||
Once you have installed Python 3 and added the source, please open a terminal and
|
Once you have installed Python 3 and added the source, please open a terminal and
|
||||||
setup a *virtualenv*, as follows:
|
setup a *virtualenv*, as follows:
|
||||||
|
|
||||||
@ -56,10 +59,6 @@ pip install tox
|
|||||||
|
|
||||||
This will install the developer dependencies for the project.
|
This will install the developer dependencies for the project.
|
||||||
|
|
||||||
## Under Windows
|
|
||||||
|
|
||||||
TBD
|
|
||||||
|
|
||||||
|
|
||||||
# 5. Get in touch.
|
# 5. Get in touch.
|
||||||
|
|
||||||
|
@ -356,12 +356,14 @@ make install
|
|||||||
|
|
||||||
##### Windows
|
##### Windows
|
||||||
|
|
||||||
If you wish to run or develop Synapse on Windows, the Windows Subsystem For
|
Running Synapse natively on Windows is not officially supported.
|
||||||
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
|
If you wish to run or develop Synapse on Windows, the Windows Subsystem for
|
||||||
be found at <https://docs.microsoft.com/en-us/windows/wsl/install-win10> for
|
Linux provides a Linux environment which is capable of using the Debian, Fedora,
|
||||||
Windows 10 and <https://docs.microsoft.com/en-us/windows/wsl/install-on-server>
|
or source installation methods. More information about WSL can be found at
|
||||||
for Windows Server.
|
<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
|
## Setting up Synapse
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user