doc: lint README.md #1498
Merged
doc: lint README.md #1498
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
vsemozhetbyt
approved these changes
Jul 8, 2018
README.md
Outdated
|
|
||
| The "binding.gyp" file | ||
| ---------------------- | ||
| ## The "binding.gyp" file |
There was a problem hiding this comment.
Maybe "binding.gyp" -> `binding.gyp`?
README.md
Outdated
| > set npm_config_devdir=c:\temp\.gyp | ||
| ``` | ||
|
|
||
| ### npm configuration |
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.
[LICENSE] -> (LICENSE) (square brackets need a bottom reference, otherwise the link is not rendered).
There was a problem hiding this comment.
I literally can't remember Markdown link syntax for my life 🙃
|
updated @vsemozhetbyt |
richardlau
reviewed
Jul 9, 2018
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: |
|
updated @richardlau |
richardlau
approved these changes
Jul 10, 2018
|
Landed in c5e9802 |
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]>
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
npm install && npm testpassesDescription 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