Skip to content
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

Jump to bottom

doc: move building nodejs into its own document #5634

Merged
merged 1 commit into from
Mar 13, 2016
Merged

doc: move building nodejs into its own document #5634

merged 1 commit into from
Mar 13, 2016

Conversation

jbergstroem
Copy link
Member

  • Does make -j8 test (UNIX) or vcbuild test nosign (Windows) pass with
    this change (including linting)?
  • Is the commit message formatted according to [CONTRIBUTING.md][0]?
  • If this change fixes a bug (or a performance problem), is a regression
    test (or a benchmark) included?
  • Is a documentation update included (if this change modifies
    existing APIs, or introduces new ones)?

Affected core subsystem(s)

Documentation

Description of change

This makes the main README easier to consume and likely less confusing for people that get it as part of a binary download.

Refs #5612 (comment).

/cc @Trott

@jbergstroem jbergstroem added the doc Issues and PRs related to the documentations. label Mar 9, 2016
Trott
Trott reviewed Mar 9, 2016
View reviewed changes
README.md

### Unix / Macintosh
See [BUILDING.md](BUILDING.md) for further instructions on how to build nodejs.
Copy link
Member

Choose a reason for hiding this comment

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

Nit: for further instructions -> for instructions

Nit: nodejs -> Node.js

Tentative nit: how to build Node.js -> how to build Node.js from source

@Trott
Copy link
Member

Trott commented Mar 9, 2016

LGTM

@Trott
Copy link
Member

Trott commented Mar 10, 2016

Tentative nit: Maybe file name should be BUILD.md rather than BUILDING.md. IIRC, BUILD is a pretty typical file to find in projects. I don't recall ever seeing a BUILDING file. (Of course, maybe I just have a terrible memory.)

@jbergstroem
Copy link
Member Author

@Trott re build vs building -- was mostly following contributing.md.

@mscdex
Copy link
Contributor

mscdex commented Mar 10, 2016

LGTM

1 similar comment
@jasnell
Copy link
Member

jasnell commented Mar 11, 2016

LGTM

@jbergstroem
doc: move build instructions to a new document
5d21496 
This makes README.md easier to consume and likely less
confusing for people that get it as part of a binary download.

PR-URL: nodejs#5634
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@jbergstroem jbergstroem force-pushed the doc/separate-build-instructions branch from 7aa09f1 to 5d21496 Compare March 13, 2016 22:23
@jbergstroem
Copy link
Member Author

CI: https://ci.nodejs.org/job/node-test-commit/2531/

@jbergstroem
Copy link
Member Author

All green. Merging.

@jbergstroem jbergstroem merged commit 5d21496 into nodejs:master Mar 13, 2016
@evanlucas evanlucas mentioned this pull request Mar 14, 2016
Closed
evanlucas pushed a commit that referenced this pull request Mar 14, 2016
@jbergstroem @evanlucas
doc: move build instructions to a new document
680db5b 
This makes README.md easier to consume and likely less
confusing for people that get it as part of a binary download.

PR-URL: #5634
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@evanlucas evanlucas mentioned this pull request Mar 14, 2016
Merged
rvagg pushed a commit that referenced this pull request Mar 16, 2016
@jbergstroem @rvagg
doc: move build instructions to a new document
c379ec6 
This makes README.md easier to consume and likely less
confusing for people that get it as part of a binary download.

PR-URL: #5634
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 17, 2016
@jbergstroem
doc: move build instructions to a new document
81a474f 
This makes README.md easier to consume and likely less
confusing for people that get it as part of a binary download.

PR-URL: #5634
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 21, 2016
@jbergstroem
doc: move build instructions to a new document
3c1d762 
This makes README.md easier to consume and likely less
confusing for people that get it as part of a binary download.

PR-URL: #5634
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 21, 2016
@jbergstroem
doc: move build instructions to a new document
b1b17ef 
This makes README.md easier to consume and likely less
confusing for people that get it as part of a binary download.

PR-URL: #5634
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@nodejs nodejs deleted a comment Jul 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jbergstroem @Trott @mscdex @jasnell @MylesBorins