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

Update prerequisites documentation #569

Merged
merged 1 commit into from
Mar 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Summary

- [Prerequisites](./prerequisites/index.md)
- [Rust](./prerequisites/rust.md)
- [npm](./prerequisites/npm.md)
- [npm (optional)](./prerequisites/npm.md)
- [Project Setup](./project-setup/index.md)
- [Using a Template](./project-setup/using-a-template.md)
- [Manual Setup](./project-setup/manual-setup.md)
Expand Down
21 changes: 15 additions & 6 deletions docs/src/prerequisites/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
# Prerequisites

To run `wasm-pack` you'll need to have both Rust and npm installed and configured.
First you'll want to [install the `wasm-pack` CLI][wasm-pack], and `wasm-pack
-V` should print the version that you just installed.

- [Rust](/wasm-pack/book/prerequisites/rust.html)
- [npm](/wasm-pack/book/prerequisites/npm.html)
[wasm-pack]: https://rustwasm.github.io/wasm-pack/installer/

In the future, we intend to rewrite the npm registry client bits so that the need
for a Node runtime is eliminated. If you're excited about that work- you should
reach out to the maintainers and get involved!
Next, since `wasm-pack` is a build tool, you'll want to make sure you have
[Rust][rust] installed. Make sure `rustc -V` prints out at least 1.30.0.

[rust]: https://www.rust-lang.org/tools/install

Finally, if you're using `wasm-pack` to install to publish to NPM, you'll want
to [install and configure `npm`][npm]. In the future, we intend to rewrite the
npm registry client bits so that the need for a Node runtime is eliminated. If
you're excited about that work- you should reach out to the maintainers and get
involved!

[npm]: npm.html
35 changes: 0 additions & 35 deletions docs/src/prerequisites/rust.md

This file was deleted.