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

Conversation

@maclover7
Copy link
Member

commented Jul 8, 2018

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

This comment has been minimized.

Copy link
Member Author

commented Jul 8, 2018

@Trott

This comment has been minimized.

Copy link
Member

commented Jul 8, 2018

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

Copy link
Contributor

left a comment

Just some mostly ignorable nits)

README.md Outdated

The "binding.gyp" file
----------------------
## The "binding.gyp" file

This comment has been minimized.

Copy link
@vsemozhetbyt

vsemozhetbyt Jul 8, 2018

Contributor

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

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

### npm configuration

This comment has been minimized.

Copy link
@vsemozhetbyt

vsemozhetbyt Jul 8, 2018

Contributor

npm -> `npm`?

README.md Outdated
## License

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

This comment has been minimized.

Copy link
@vsemozhetbyt

vsemozhetbyt Jul 8, 2018

Contributor

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

This comment has been minimized.

Copy link
@maclover7

maclover7 Jul 9, 2018

Author Member

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

@maclover7

This comment has been minimized.

Copy link
Member Author

commented Jul 9, 2018

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:

This comment has been minimized.

Copy link
@richardlau

richardlau Jul 9, 2018

Member

coud->could

@maclover7

This comment has been minimized.

Copy link
Member Author

commented Jul 9, 2018

updated @richardlau

@maclover7

This comment has been minimized.

Copy link
Member Author

commented Jul 10, 2018

@maclover7 maclover7 merged commit c5e9802 into nodejs:master Jul 19, 2018
@maclover7

This comment has been minimized.

Copy link
Member Author

commented Jul 19, 2018

Landed in c5e9802

@maclover7 maclover7 deleted the maclover7:jm-docs branch Jul 19, 2018
rvagg added 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 <vsemozhetbyt@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@rvagg rvagg referenced this pull request Apr 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.