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.

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

doc: lint README.md #1498

Merged
merged 3 commits into from
Jul 19, 2018
Merged

doc: lint README.md #1498

merged 3 commits into from
Jul 19, 2018

Conversation

maclover7
Copy link
Contributor

Checklist
  • npm install && npm test passes
  • documentation is changed or added
  • commit message follows commit guidelines
Description of change

Fixes grammar, removes extra lines and spaces, etc. Also removes a few
references to node-waf, which was removed ~6 years ago now. Happy to
add back if people still need that information.

cc docs guru @Trott

Fixes grammar, removes extra lines and spaces, etc. Also removes a few
references to `node-waf`, which was removed ~6 years ago now. Happy to
add back if people still need that information.
@maclover7
Copy link
Contributor Author

maclover7 commented Jul 8, 2018

@Trott
Copy link
Member

Trott commented Jul 8, 2018

I'll in turn ping @vsemozhetbyt. :-D

Copy link
Contributor

@vsemozhetbyt vsemozhetbyt left a comment

Choose a reason for hiding this comment

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

Just some mostly ignorable nits)

README.md Outdated

The "binding.gyp" file
----------------------
## The "binding.gyp" file
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe "binding.gyp" -> `binding.gyp`?

README.md Outdated
> set npm_config_devdir=c:\temp\.gyp
```

### npm configuration
Copy link
Contributor

Choose a reason for hiding this comment

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

npm -> `npm`?

README.md Outdated
## License

`node-gyp` is available under the MIT license. See the [LICENSE
file][LICENSE] for details.
Copy link
Contributor

Choose a reason for hiding this comment

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

[LICENSE] -> (LICENSE) (square brackets need a bottom reference, otherwise the link is not rendered).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I literally can't remember Markdown link syntax for my life 🙃

@maclover7
Copy link
Contributor Author

updated @vsemozhetbyt

README.md Outdated

A barebones `gyp` file appropriate for building a node addon looks like:
A barebones `gyp` file appropriate for building a Node.js addon coud look like:
Copy link
Member

Choose a reason for hiding this comment

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

coud->could

@maclover7
Copy link
Contributor Author

updated @richardlau

@maclover7
Copy link
Contributor Author

@maclover7 maclover7 merged commit c5e9802 into nodejs:master Jul 19, 2018
@maclover7
Copy link
Contributor Author

Landed in c5e9802

@maclover7 maclover7 deleted the jm-docs branch July 19, 2018 19:35
rvagg pushed a commit that referenced this pull request Apr 24, 2019
Fixes grammar, removes extra lines and spaces, etc. Also removes a few
references to `node-waf`, which was removed ~6 years ago now. Happy to
add back if people still need that information.

PR-URL: #1498
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
@rvagg rvagg mentioned this pull request Apr 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants