Add instructions to README for using crate and publishing#93
Merged
Conversation
Comment on lines
+41
to
+48
| ## Publishing to crates.io | ||
|
|
||
| To publish this crate to crates.io, you will need to ensure the `QUICKJS_WASM_SYS_WASI_SDK_PATH` is set to a value pointing to the absolute path where you installed the `wasi-sdk`. The `--target` parameter will also need to be set to `wasm32-wasi`. | ||
|
|
||
| E.g., | ||
|
|
||
| ``` | ||
| QUICKJS_WASM_SYS_WASI_SDK_PATH=/opt/wasi-sdk cargo publish --target=wasm32-wasi |
Member
There was a problem hiding this comment.
I wonder if it's more effective to have all these instructions materialized in a bash script and we can just run it when we want to publish, or invoke it from a GH action if we ever hook that up.
Collaborator
Author
There was a problem hiding this comment.
I can do that 👍. I'll still need to document that we need to run the script because a barebones cargo publish fails with a misleading error message.
saulecabrera
approved these changes
Mar 16, 2022
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Had to set a few non-standard things to publish this crate so thought I'd document them in the README.