Skip to content

Commit

Permalink
doc: add note for windows users and symlinks
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
RedYetiDev authored May 25, 2024
1 parent d0a7272 commit aaca18b
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit aaca18b

Please sign in to comment.