src/doc/edition-guide/README.md

   1 # The Rust Edition Guide
   2
   3 This book explains the concept of "editions", major new eras in [Rust]'s
   4 development. You can [read the book
   5 online](https://doc.rust-lang.org/nightly/edition-guide/).
   6
   7 [Rust]: https://www.rust-lang.org/
   8
   9 ## License
  10
  11 The Edition Guide is dual licensed under `MIT`/`Apache2`, just like Rust itself.
  12 See the `LICENSE-*` files in this repository for more details.
  13
  14 ## Building locally
  15
  16 You can also build the book and read it locally if you'd like.
  17
  18 ### Requirements
  19
  20 Building the book requires [mdBook] 0.4. To get it:
  21
  22 [mdBook]: https://github.com/rust-lang/mdBook
  23
  24 ```bash
  25 $ cargo install mdbook
  26 ```
  27
  28 ### Building
  29
  30 The most straight-forward way to build and view the book locally is to use the following command:
  31 ```bash
  32 $ mdbook serve --open
  33 ```
  34
  35 This builds the HTML version of the book, starts a webserver at
  36 http://localhost:3000, and opens your default web browser. It will also
  37 automatically rebuild the book whenever the source changes, and the page
  38 should automatically reload.
  39
  40 To run the tests:
  41
  42 ```bash
  43 $ mdbook test
  44 ```