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

docs: update README #30 #31

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

docs: update README #30 #31

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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,34 @@
yarn add --dev @wasm-tool/wasm-pack-plugin
```

### Rust lang

Rust >= `rustc 1.31.0-nightly` is required to fetch and compile rust wasm. Rust is installed and managed using [`rustup`](https://rustup.rs/)

### `wasm-pack`

We expect `wasm-pack` to be in your `$PATH`. See [installation here](https://github.com/rustwasm/wasm-pack/blob/master/docs/src/setup.md#installing-wasm-pack).

### `wasm-bindgen-cli`
Copy link
Member

Choose a reason for hiding this comment

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

@fitzgen mentioned that this isn't needed. Could you please take a look @fitzgen

Copy link
Contributor

Choose a reason for hiding this comment

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

Using the >= 0.5.0 versions of wasm-pack will automatically install the wasm-bindgen CLI for you (and the right version!) if necessary, so it shouldn't be a prerequisite to already have it installed anymore.

Just sent #36 too since we generally don't want to encourage -m no-install.

Copy link
Author

Choose a reason for hiding this comment

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

Not sure what you mean, I ran into issue #30 with 0.5.1 of wasm-pack.

Copy link
Contributor

Choose a reason for hiding this comment

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

That was because no-install mode was used, which forces wasm-pack into not downloading the w32-u-u target

Copy link
Contributor

Choose a reason for hiding this comment

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

There have been commits since then that removed the use of no-install, btw.


`wasm-bindgen` is a build requirement for `wasm-pack` and a dependency of `wasm-bindgen-cli`. To verify installation, run:
Copy link
Member

Choose a reason for hiding this comment

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

But wont wasm-pack installs this automatically from v0.5


```
which wasm-bindgen
```

If a path is not returned, install `wasm-bindgen-cli` using the cargo package manager:

```
cargo +nightly install wasm-bindgen-cli
```

Following installation, you may be prompted to upgrade the `wasm-bindgen` dependency. This can be done using the following:

```
cargo update -p wasm-bindgen
```

## Usage

Add the loader in your `webpack.config.js`:
Expand Down