add: Documentation for Windows

Author: mleutenegger

README.md

@@ -8,20 +8,12 @@
 ssdev makes Silverstripe development easy. Stop worrying about your LAMP, MAMP
 or WAMP stack and start developing awesome websites and applications!
 
-> 🚨 **WANTED: Feedback from Windows & Linux users!**
->
-> ssdev is extensively tested and developed on macOS, as this is what we work on.
-> To find bugs or problems on other systems, we need your feedback from using
-> ssdev on Linux or Windows
-
-## 🧩 Requirements
-For ssdev to work correctly, you have to install
-* Docker ([installation instructions](https://www.docker.com/products/docker-desktop)) - We recommend to install Docker desktop on Windows, as a native installation under wsl tends to not work correctly.
-* Node & npm *(& npx)* ([installation instructions](https://nodejs.org/en/download/))
-
-> Users on Mac and Windows will have to set up nfs.
->
-> → see [📚 Configuring NFS on macOS](docs/nfs/macos.md).
+## 🧩 Prerequisites
+ssdev works on most systems. In order for it to work properly, you need to install some prerequisites. Please follow the instructions for your OS:
+
+* [macOS](docs/os/macos.md)
+* [Windows](docs/os/windows.md)
+* [Linux](docs/os/linux.md)
 
 ## 📦 Installation
 You can run ssdev without installing it using npx:

docs/nfs/macos.md

@@ -0,0 +1,13 @@
+# Using `ssdev` on linux
+
+> 🚨 **WANTED: Feedback from Linux users!**
+>
+> ssdev is extensively tested and developed on macOS and Windows, as this is what we work on.
+> To find bugs or problems on linux systems, we need your feedback.
+
+In order to use ssdev efficiently, you need to install the following:
+* Docker ([installation instructions](https://www.docker.com/))
+* Node & npm *(& npx)* ([installation instructions](https://nodejs.org/en/download/))
+
+After installing the prerequisites, you can follow up with installation of ssdev.
+

docs/os/linux.md

@@ -0,0 +1,38 @@
+# Using `ssdev` on macOS
+
+In order to use ssdev efficiently, you need to install the following:
+* Docker ([installation instructions](https://www.docker.com/products/docker-desktop))
+* Node & npm *(& npx)* ([installation instructions](https://nodejs.org/en/download/))
+
+After installing the prerequisites, you can follow up with installation of ssdev.
+
+## NFS on macOS
+> **Note:** with newer versions of Docker for desktop, the default driver for bind mounts
+> has gotten very performant. This means, that you will most likely not be needing NFS-mounts
+> anymore. We recommend to check performance before setting up NFS
+
+
+In order to share files to the container and keep a speedy environment,
+we use an nfs mount instead of the native filesystem mount.
+
+For this to work, you have to give the necessary permissions to docker desktop.
+
+### Configuring NFS Exports
+
+Add the following to your `/etc/exports`:
+
+```
+/System/Volumes/Data -alldirs -mapall=501:20 localhost
+```
+
+and add the following to `/etc/nfs.conf`:
+
+```
+nfs.server.mount.require_resv_port = 0
+```
+
+### Add Permissions
+
+In order for Docker and NFS to work, you have to open Settings > Security
+and give access to the desired directories (or full disk access) to `Docker`
+and `nfsd`

docs/os/mac.md

@@ -0,0 +1,16 @@
+# Using `ssdev` on Windows
+
+Using ssdev on Windows system is best achieved using WSL. Please follow the steps below
+to achieve a performant development experience. Also, we recommend VSCode, as it comes
+with an extension for WSL.
+
+1. Set up WSL and install a distro ([instructions by Microsoft](https://learn.microsoft.com/de-de/windows/wsl/setup/environment#set-up-your-linux-username-and-password))
+2. Open a Terminal in your WSL Distro and install Node & npm *(& npx)* ([instructions by Microsoft](https://learn.microsoft.com/de-de/windows/dev-environment/javascript/nodejs-on-wsl))
+3. install the WSL-extension in VSCode
+4. [Install Docker for Desktop](https://www.docker.com/products/docker-desktop)
+5. install ssdev inside the WSL environment
+
+The best approach is treating the WSL distro as a remote server and using it to develop your projects.
+This means that it is best practice to use git inside the distro. You can open any project in VSCode 
+by typing `code .` in the respective directory.
+