Skip to content

doc: add note for windows users and symlinks #53117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 25, 2024
Merged

doc: add note for windows users and symlinks #53117

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d3c3f8
doc: add note for windows users and symlinks
avivkeller May 23, 2024
4732654
Update BUILDING.md
avivkeller May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions BUILDING.md
View file
Open in desktop
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