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

Add to Node Core documention #386

Closed
mhdawson opened this issue Oct 7, 2019 · 2 comments
Closed

Add to Node Core documention #386

mhdawson opened this issue Oct 7, 2019 · 2 comments
Assignees
Milestone

Comments

@mhdawson
Copy link
Member

mhdawson commented Oct 7, 2019

Add to core documentation which covers 2 options for building your packages

  • gyp
  • cmake

Add to https://nodejs.org/dist/latest-v12.x/docs/api/addons.html#addons_building

Also talk about prebuild etc.?

@mhdawson mhdawson added this to the Milestone 11 milestone Oct 7, 2019
@mhdawson
Copy link
Member Author

mhdawson commented Oct 7, 2019

Duplicate of #384

@jschlight
Copy link
Collaborator

It looks like the Building section on the proposed C++ Addons documentation page is part of a "Hello world" tutorial.

  • Would it be better to create a new Building section on this page?

    https://nodejs.org/dist/latest-v12.x/docs/api/n-api.html

    It could go after Usage.

  • Are there documentation guidelines for these pages? For example, linking to sites not maintained by the Node.js Foundation?

    I'm thinking this section should be at a "high-level" with links to the specific tools for the details.

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

No branches or pull requests

2 participants