2015-12-12 06:50:02 +08:00
|
|
|
|
# The Rust Programming Language
|
|
|
|
|
|
|
|
|
|
|
|
This is the next iteration of “The Rust Programming Language”, which is
|
|
|
|
|
|
currently located [in the main Rust repository][src]. If you want to read the
|
|
|
|
|
|
book, you should check it out there or [on the web][prod].
|
|
|
|
|
|
|
|
|
|
|
|
[src]: https://github.com/rust-lang/rust/tree/master/src/doc/book
|
|
|
|
|
|
[prod]: https://doc.rust-lang.org/book/
|
|
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
|
|
Building the book requires [mdBook]. To get it:
|
|
|
|
|
|
|
2015-12-14 22:45:33 +08:00
|
|
|
|
[mdBook]: https://github.com/azerupi/mdBook
|
2015-12-12 06:50:02 +08:00
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
$ cargo install mdbook
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
|
|
To build the book, type:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
2015-12-15 01:11:06 +08:00
|
|
|
|
$ make
|
2015-12-12 06:50:02 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
The output will be in the `book` subdirectory. To check it out, open it in
|
|
|
|
|
|
your web browser:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
$ firefox book/index.html
|
|
|
|
|
|
```
|
|
|
|
|
|
|
2015-12-15 01:11:06 +08:00
|
|
|
|
To run the tests:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
$ make test
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
To do both:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
$ make all
|
|
|
|
|
|
```
|
|
|
|
|
|
|
2015-12-12 06:50:02 +08:00
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
|
|
I’m not going to be accepting major changes at first, but pull requests to fix
|
|
|
|
|
|
typos and such are welcome. Please file any issues for discussion of larger
|
|
|
|
|
|
changes.
|
|
|
|
|
|
|
|
|
|
|
|
This repository is under the same license as Rust itself, MIT/Apache2.
|
