fluencelabs/wasm-bindgen
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasm-bindgen synced 2025-06-24 02:01:35 +00:00
Code Issues Projects Releases Wiki Activity

Clarify some introductory docs

Browse Source 
* Note that after the game of life tutorial there's also wasm-pack tutorials
* Ensure that the hello world example is clear that webpack isn't
  required inline in addition to the text on other pages.
This commit is contained in:
Alex Crichton
2019-03-21 08:44:53 -07:00
parent d49d8c9e1b
commit e39b5c1121
2 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
guide/src/examples/hello-world.md
View File

@ -40,6 +40,11 @@ Our JS entry point is quite small!
## Webpack-specific files ## Webpack-specific files
> **Note**: Webpack is not required for this example, and if you're interested
> in options that don't use a JS bundler [see other examples][wab].
[wab]: without-a-bundler.html
And finally here's the Webpack configuration and `package.json` for this And finally here's the Webpack configuration and `package.json` for this
project: project:

6
guide/src/examples/index.md
View File

@ -6,12 +6,13 @@ doing.
These examples all assume familiarity with `wasm-bindgen`, `wasm-pack`, and These examples all assume familiarity with `wasm-bindgen`, `wasm-pack`, and
building a Rust and WebAssembly project. If you're unfamiliar with these check building a Rust and WebAssembly project. If you're unfamiliar with these check
out the [Game of Life tutorial][gol] to help you get started. out the [Game of Life tutorial][gol] or [wasm pack tutorials][wpt] to help you
get started.
The source code for all examples can also be [found online][code] to download The source code for all examples can also be [found online][code] to download
and run locally. Most examples are configured with Webpack/`wasm-pack` and can and run locally. Most examples are configured with Webpack/`wasm-pack` and can
be built with `npm run serve`. Other examples which don't use Webpack are be built with `npm run serve`. Other examples which don't use Webpack are
accompanied with a `build.sh` showing how to build it. accompanied with instructions or a `build.sh` showing how to build it.
Note that most examples currently use Webpack to assemble the final output Note that most examples currently use Webpack to assemble the final output
artifact, but this is not required! You can review the [deployment artifact, but this is not required! You can review the [deployment
@ -20,3 +21,4 @@ documentation][deploy] for other options of how to deploy Rust and WebAssembly.
[code]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples [code]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples
[gol]: https://rustwasm.github.io/docs/book/ [gol]: https://rustwasm.github.io/docs/book/
[deploy]: ../reference/deployment.html [deploy]: ../reference/deployment.html
[wpt]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html