From a7e7e20b2bb2d0516ece878c8f3ea0dcf67352cc Mon Sep 17 00:00:00 2001
From: Philipp Baumann <baumann-philipp@proton.me>
Date: Thu, 3 Aug 2023 15:38:22 +0200
Subject: [PATCH] WIP update win notes

---
 README.Rmd | 15 ++++++++++++++-
 README.md  | 14 ++++++++++++++
 2 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.Rmd b/README.Rmd
index 969f16d7..3ca6111f 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -165,6 +165,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
@@ -173,4 +187,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).
-
diff --git a/README.md b/README.md
index cbf50309..b382a165 100644
--- a/README.md
+++ b/README.md
@@ -156,6 +156,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