1  <div align="center">
 2  
 3    <h1>The Rust and WebAssembly Book</h1>
 4  
 5    <strong>This small book describes how to use Rust and WebAssembly together.  It also consists of tutorials with cool exercises.</strong>
 6  
 7    <h3>
 8      <a href="https://rustwasm.github.io/docs/book/">Read the Book</a>
 9      <span> | </span>
10      <a href="https://github.com/rustwasm/book/blob/master/CONTRIBUTING.md">Contributing</a>
11      <span> | </span>
12      <a href="https://discordapp.com/channels/442252698964721669/443151097398296587">Chat</a>
13    </h3>
14  
15    <sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
16  </div>
17  
18  ## About
19  
20  This repo contains documentation on using Rust for wasm, common workflows, how
21  to get started and more as you dive deeper. It acts as a guide for doing some really neat things with rust.
22  
23  If you would like to start learning how to use Rust and WebAssembly together,
24   you can read the book [online here][book].
25  
26  [Open issues for improving the Rust and WebAssembly book.][book-issues]
27  
28  [book-issues]: https://github.com/rustwasm/book/issues
29  
30  ## Building the Book
31  
32  The book is made using [`mdbook`][mdbook]. To install it you'll need `cargo`
33  installed. If you don't have any Rust tooling installed, you'll need to install
34  [`rustup`][rustup] first. Follow the instructions on the site in order to get
35  setup.
36  
37  Once you have that done then just do the following:
38  
39  ```bash
40  $ cargo install mdbook
41  ```
42  
43  Make sure the `cargo install` directory is in your `$PATH` so that you can run
44  the binary.
45  
46  Now just run this command from this directory:
47  
48  ```bash
49  $ mdbook build
50  ```
51  
52  This will build the book and output files into a directory called `book`. From
53  there you can navigate to the `index.html` file to view it in your browser. You
54  could also run the following command to automatically generate changes if you
55  want to look at changes you might be making to it:
56  
57  ```bash
58  $ mdbook serve
59  ```
60  
61  This will automatically generate the files as you make changes and serves them
62  locally so you can view them easily without having to call `build` every time.
63  
64  The files are all written in Markdown so if you don't want to generate the book
65  to read them then you can read them from the `src` directory.
66  
67  [mdbook]: https://github.com/rust-lang-nursery/mdBook
68  [rustup]: https://github.com/rust-lang-nursery/rustup.rs/
69  [book]: https://rustwasm.github.io/book/game-of-life/introduction.html