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

Update README.md by adding missing formattings #2617

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md by adding missing formattings #2617

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ different build configurations from the official Node.js distribution, you
should use `--dist-url` or `--nodedir` flags to specify the headers of the
runtime to build for.

Also when `--dist-url` or `--nodedir` flags are passed, node-gyp will use the
Also when `--dist-url` or `--nodedir` flags are passed, `node-gyp` will use the
`config.gypi` shipped in the headers distribution to generate build
configurations, which is different from the default mode that would use the
`process.config` object of the running Node.js instance.

Some old versions of Electron shipped malformed `config.gypi` in their headers
distributions, and you might need to pass `--force-process-config` to node-gyp
distributions, and you might need to pass `--force-process-config` to `node-gyp`
to work around configuration errors.

## How to Use
Expand Down Expand Up @@ -162,7 +162,7 @@ A barebones `gyp` file appropriate for building a Node.js addon could look like:

## Further reading

The **[docs](./docs/)** directory contains additional documentation on specific node-gyp topics that may be useful if you are experiencing problems installing or building addons using node-gyp.
The **[docs](./docs/)** directory contains additional documentation on specific `node-gyp` topics that may be useful if you are experiencing problems installing or building addons using `node-gyp`.

Some additional resources for Node.js native addons and writing `gyp` configuration files:

Expand Down