[rustc.git] / src / doc / edition-guide / README.md

# The Rust Edition Guide

This book explains the concept of "editions", major new eras in [Rust]'s
development. You can [read the book
online](https://doc.rust-lang.org/nightly/edition-guide/).

[Rust]: https://www.rust-lang.org/

## License

The Edition Guide is dual licensed under `MIT`/`Apache2`, just like Rust itself.
See the `LICENSE-*` files in this repository for more details.

## Building locally

You can also build the book and read it locally if you'd like.

### Requirements

Building the book requires [mdBook] 0.4. To get it:

[mdBook]: https://github.com/rust-lang/mdBook

```bash
$ cargo install mdbook
```

### Building

The most straight-forward way to build and view the book locally is to use the following command:
```bash
$ mdbook serve --open
```

This builds the HTML version of the book, starts a webserver at
http://localhost:3000, and opens your default web browser. It will also
automatically rebuild the book whenever the source changes, and the page
should automatically reload.

To run the tests:

```bash
$ mdbook test
```
Commit	Line	Data
450edc1f XL	1	# The Rust Edition Guide
450edc1f XL	2
450edc1f XL	3	This book explains the concept of "editions", major new eras in [Rust]'s
450edc1f XL	4	development. You can [read the book
532ac7d7	5	online](https://doc.rust-lang.org/nightly/edition-guide/).
450edc1f XL	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
6a06907d	20	Building the book requires [mdBook] 0.4. To get it:
450edc1f	21
6a06907d	22	[mdBook]: https://github.com/rust-lang/mdBook
450edc1f XL	23
	24	```bash
	25	$ cargo install mdbook
	26	```
	27
	28	### Building
	29
532ac7d7	30	The most straight-forward way to build and view the book locally is to use the following command:
450edc1f	31	```bash
6a06907d	32	$ mdbook serve --open
450edc1f XL	33	```
450edc1f XL	34
6a06907d XL	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.
450edc1f XL	39
	40	To run the tests:
	41
	42	```bash
	43	$ mdbook test
	44	```