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/
|
|
|
|
|
|
|
2015-12-16 05:49:11 +08:00
|
|
|
|
If you would like to see this version rendered, it’s [on GitHub pages][html].
|
2015-12-15 04:00:58 +08:00
|
|
|
|
|
|
|
|
|
|
[html]: http://rust-lang.github.io/book/
|
|
|
|
|
|
|
2015-12-12 06:50:02 +08:00
|
|
|
|
## 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
|
2015-12-19 03:48:16 +08:00
|
|
|
|
typos and such are welcome. Please file any issues for any bugs you find, and
|
|
|
|
|
|
utilize the issue tagged with `Discussion` to raise any larger questions /
|
|
|
|
|
|
feedback.
|
2015-12-12 06:50:02 +08:00
|
|
|
|
|
|
|
|
|
|
This repository is under the same license as Rust itself, MIT/Apache2.
|
2015-12-19 03:48:16 +08:00
|
|
|
|
|
|
|
|
|
|
There are a number of labels on Issues:
|
|
|
|
|
|
|
|
|
|
|
|
* `Discussion` issues are for discussing the chapters. There’s an issue per
|
|
|
|
|
|
section.
|
|
|
|
|
|
* `Bug` issues indicate problems in the text.
|
|
|
|
|
|
* `Needs Backport` will be used when we are further along. At some point, we
|
|
|
|
|
|
will import the text into their review system, and so changes made here will
|
|
|
|
|
|
need to be upstreamed. This will track those.
|
|
|
|
|
|
|
2015-12-22 03:03:31 +08:00
|
|
|
|
Finally, there’s the `S-` labels, which are for various ‘status’es:
|
2015-12-19 03:48:16 +08:00
|
|
|
|
|
|
|
|
|
|
* `S-initial`: Steve has not done any work here yet.
|
|
|
|
|
|
* `S-rough-draft`: Steve has worked up a rough draft of what this section will
|
|
|
|
|
|
look like.
|
|
|
|
|
|
* `S-under-review`: Aaron and Steve are in the process of reviewing this
|
|
|
|
|
|
section.
|
|
|
|
|
|
* `S-done`: imported into No Starch’s system. There may still be changes based
|
|
|
|
|
|
on their feedback, even after a section is marked `S-done`.
|
|
|
|
|
|
|
