-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
doc: lint README.md #1498
Conversation
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.
I'll in turn ping @vsemozhetbyt. :-D |
There was a problem hiding this 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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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 🙃
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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
coud
->could
updated @richardlau |
Landed in c5e9802 |
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>
Checklist
npm install && npm test
passesDescription 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 toadd back if people still need that information.
cc docs guru @Trott