From aaca18b54efc74e8c005547fe085d08168dc9a95 Mon Sep 17 00:00:00 2001
From: Aviv Keller <38299977+RedYetiDev@users.noreply.github.com>
Date: Sat, 25 May 2024 15:00:10 -0400
Subject: [PATCH] doc: add note for windows users and symlinks
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

PR-URL: https://github.com/nodejs/node/pull/53117
Reviewed-By: Stefan Stojanovic <stefan.stojanovic@janeasystems.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
---
 BUILDING.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/BUILDING.md b/BUILDING.md
index 7148fe8e6ac..c42c7877272 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -691,6 +691,15 @@ disk space.
   git clone https://github.com/nodejs/node.git
   cd node
   ```
+
+> \[!TIP]
+> If you are building from a Windows machine, symlinks are disabled by default, and can be enabled by cloning
+> with the `-c core.symlinks=true` flag.
+>
+> ```powershell
+> git clone -c core.symlinks=true <repository_url>
+> ```
+
 * If the path to your build directory contains a space or a non-ASCII character,
   the build will likely fail