create-neon README #697
Merged
create-neon README #697
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
kjvalencik
reviewed
Mar 11, 2021
| You can build the project with npm. In the project directory, run: | ||
|
|
||
| ```sh | ||
| $ npm install |
There was a problem hiding this comment.
I would call this installing and not building. Building can be documented as npm run build. In many cases, users will want to run npm run build instead of npm install because it will be more efficient. npm install needs to check the dependency tree and potentially install updates.
| ### `npm test` | ||
|
|
||
| Runs the unit tests by calling `cargo test`. You can learn more about [adding tests to your Rust code](https://doc.rust-lang.org/book/ch11-01-writing-tests.html) from the [Rust book](https://doc.rust-lang.org/book/). | ||
|
|
There was a problem hiding this comment.
Can you add npm run build? In this section, can you also explain what cargo-cp-artifact does?
|
|
||
| ### index.node | ||
|
|
||
| The binary module generated by building the project. |
There was a problem hiding this comment.
Can you add a bit explaining that this is a C dynamic shared library generated by cargo and that it's a copy of the file in target/?
|
Great feedback, @kjvalencik, thank you. 👍 Ready for re-review! |
kjvalencik
approved these changes
Mar 12, 2021
This was referenced Jun 6, 2021
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.
Project README and more content for the generated README.
Closes #695.