Skip to content

doc: update BUILDING.md #8704

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

Closed
wants to merge 4 commits into from
Closed

doc: update BUILDING.md #8704

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7fab1fc
Update BUILDING.md
rainabba Sep 21, 2016
df27e59
Update BUILDING.md
rainabba Sep 22, 2016
3686894
squash: nits
Trott Sep 22, 2016
1bc3fcb
Merge pull request #1 from Trott/patch-1
rainabba Sep 22, 2016
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
3 changes: 2 additions & 1 deletion BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@ Prerequisites:
* Basic Unix tools required for some tests,
[Git for Windows](http://git-scm.com/download/win) includes Git Bash
and tools which can be included in the global `PATH`.
* vcbuild is provided by this repo as a batch file so if using powershell, use local syntax `./vcbuild nosign`

Please note that vcbuild is a batch file provided with the Node.js source code. If using PowerShell, use local syntax. For example: ./vcbuild nosign
Copy link
Member

@richardlau richardlau Sep 22, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is Windows, wouldn't .\ be more correct (and work in cmd.exe and PowerShell)? Is there any reason not to prefix all the examples .\ (e.g. .\vcbuild) to be consistent with ./configure/./node examples in the Unix / OS X section?

Copy link
Member

@Trott Trott Sep 22, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds like an even better solution if that will work on all common Windows environments.

Copy link
Contributor Author

@rainabba rainabba Sep 22, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point!

Copy link
Member

@fhinkel fhinkel Sep 22, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't know what local syntax means in that context. I'd prefer use a leading .\.

Copy link
Member

@ChALkeR ChALkeR Sep 22, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you enclose vcbuild and ./vcbuild nosign in backticks to format them as code?
Also, this probably misses a trailing dot.


```console
> vcbuild nosign
Expand Down