doc: add note for windows users and symlinks

PR-URL: #53117 Reviewed-By: Stefan Stojanovic <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]>
nodejs · May 25, 2024 · aaca18b · aaca18b
1 parent d0a7272
commit aaca18b
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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