Merge pull request #12 from philipp-baumann/add-win-notes-at-bottom

WIP update win notes

README.Rmd

@@ -167,6 +167,20 @@ nix-shell /absolute/path/to/housing/default.nix --run Rscript -e 'targets::tar_m
 It's possible to execute the pipeline automatically using a so-called "shell
 hook". See the "Non-interactive use" vignette for more details.
 
+## Windows how-to
+
+Since Nixpkgs needs a UNIX environment, the Windows Subsystem for Linux 2 (WSL2)
+is required to build and run the nix shell under Windows. If you are on a recent
+version of Windows 10 or 11, you can simply run this as an administrator
+in the PowerShell.
+
+```{ps}
+wsl --install
+```
+
+Further installation notes you can find at
+[this official MS documentation](https://learn.microsoft.com/en-us/windows/wsl/install).
+
 ## Contributing
 
 This package is developed using the `{fusen}` package. If you want to
@@ -175,4 +189,3 @@ inflate the package using `fusen::inflate_all()`. If no errors are found
 (warning and notes are ok), then commit and open a PR. To learn how to use
 `{fusen}` (don't worry, it's super easy), refer to this
 [vignette](https://thinkr-open.github.io/fusen/articles/How-to-use-fusen.html).
-

README.md

@@ -158,6 +158,20 @@ by running:
 It’s possible to execute the pipeline automatically using a so-called
 “shell hook”. See the “Non-interactive use” vignette for more details.
 
+## Windows how-to
+
+Since Nixpkgs needs a UNIX environment, the Windows Subsystem for Linux
+2 (WSL2) is required to build and run the nix shell under Windows. If
+you are on a recent version of Windows 10 or 11, you can simply run this
+as an administrator in the PowerShell.
+
+``` ps
+wsl --install
+```
+
+Further installation notes you can find at [this official MS
+documentation](https://learn.microsoft.com/en-us/windows/wsl/install).
+
 ## Contributing
 
 This package is developed using the `{fusen}` package. If you want to