From e1921658ec9dbaabb8d2cd20cd9611938dc0f25f Mon Sep 17 00:00:00 2001
From: Kevin Mauel <kevin.mauel2+github@gmail.com>
Date: Sun, 15 Sep 2024 11:58:03 +0200
Subject: [PATCH] feat: add os specific settings to README.md

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 0983835..40684fa 100644
--- a/README.md
+++ b/README.md
@@ -57,3 +57,21 @@ Or with coverage in build directory
 ```sh
 docker compose exec app pnpm run test:coverage
 ```
+
+## OS specific settings
+
+### Windows + WSL2 + Symlinks + PNPM
+
+In case your running a setup like me,
+WSL2 with Ubuntu and have your IDE running on Windows,
+your IDE may not be able to use symlinks created by pnpm.
+For this scenario you can do the following
+
+```
+cp .npmrc.dist .npmrc
+make build
+make up
+make install
+```
+
+This will run pnpm without symlinks.