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

Some fix on documentation and added new section dedicated to prebuild tools #353

Closed
wants to merge 7 commits into from
Closed

Some fix on documentation and added new section dedicated to prebuild tools #353

wants to merge 7 commits into from

Conversation

NickNaso
Copy link
Member

In this PR I fixed some inconsistencies over the Napi::BigInt and Napi::DataView documentation, then I added a new section called pre build tools where I tried to briefly explain what is a pre build tool and why it's important use one of them.
Please review.

@NickNaso NickNaso changed the title Some fix and section dedicated to prebuild tools Some fix on documentation and added new section dedicated to prebuild tools Sep 24, 2018
The end-user will need to compile the add-on when they will do an `npm install`
and in some cases this could create problems. To avoid the compilation process it's
possible to ditribute the native add-on in pre-built form for different platform
and architecture. The prebuild tools help to create and distrubute the pre-built
Copy link
Member

Choose a reason for hiding this comment

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

architecture -> architectures

doc/prebuild_tools.md Outdated Show resolved Hide resolved
doc/prebuild_tools.md Outdated Show resolved Hide resolved
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM with a few nits

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

mhdawson pushed a commit that referenced this pull request Sep 28, 2018
- Some fix on bigint and dataview.
- Add section dedicated to prebuild tools.

PR-URL: #353
Reviewed-By: Michael Dawson <[email protected]>
@mhdawson
Copy link
Member

Landed as 51ffe45

@mhdawson mhdawson closed this Sep 28, 2018
kevindavies8 added a commit to kevindavies8/node-addon-api-Develop that referenced this pull request Aug 24, 2022
- Some fix on bigint and dataview.
- Add section dedicated to prebuild tools.

PR-URL: nodejs/node-addon-api#353
Reviewed-By: Michael Dawson <[email protected]>
Marlyfleitas added a commit to Marlyfleitas/node-api-addon-Development that referenced this pull request Aug 26, 2022
- Some fix on bigint and dataview.
- Add section dedicated to prebuild tools.

PR-URL: nodejs/node-addon-api#353
Reviewed-By: Michael Dawson <[email protected]>
wroy7860 added a commit to wroy7860/addon-api-benchmark-node that referenced this pull request Sep 19, 2022
- Some fix on bigint and dataview.
- Add section dedicated to prebuild tools.

PR-URL: nodejs/node-addon-api#353
Reviewed-By: Michael Dawson <[email protected]>
johnfrench3 pushed a commit to johnfrench3/node-addon-api-git that referenced this pull request Aug 11, 2023
- Some fix on bigint and dataview.
- Add section dedicated to prebuild tools.

PR-URL: nodejs/node-addon-api#353
Reviewed-By: Michael Dawson <[email protected]>
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.

2 participants