-% The Advanced Rust Programming Language
+# The Rust Programming Language
-# NOTE: This is a draft document, and may contain serious errors
+Rust is a fast systems programming language that guarantees
+memory safety and offers painless concurrency ([no data races]).
+It does not employ a garbage collector and has minimal runtime overhead.
-So you've played around with Rust a bit. You've written a few simple programs and
-you think you grok the basics. Maybe you've even read through
-*[The Rust Programming Language][trpl]*. Now you want to get neck-deep in all the
-nitty-gritty details of the language. You want to know those weird corner-cases.
-You want to know what the heck `unsafe` really means, and how to properly use it.
-This is the book for you.
+This repo contains the code for the compiler (`rustc`), as well
+as standard libraries, tools and documentation for Rust.
-To be clear, this book goes into *serious* detail. We're going to dig into
-exception-safety and pointer aliasing. We're going to talk about memory
-models. We're even going to do some type-theory. This is stuff that you
-absolutely *don't* need to know to write fast and safe Rust programs.
-You could probably close this book *right now* and still have a productive
-and happy career in Rust.
+[no data races]: http://blog.rust-lang.org/2015/04/10/Fearless-Concurrency.html
-However if you intend to write unsafe code -- or just *really* want to dig into
-the guts of the language -- this book contains *invaluable* information.
+## Quick Start
-Unlike *The Rust Programming Language* we *will* be assuming considerable prior
-knowledge. In particular, you should be comfortable with:
+Read ["Installing Rust"] from [The Book].
-* Basic Systems Programming:
- * Pointers
- * [The stack and heap][]
- * The memory hierarchy (caches)
- * Threads
+["Installing Rust"]: https://doc.rust-lang.org/book/installing-rust.html
+[The Book]: https://doc.rust-lang.org/book/index.html
-* [Basic Rust][]
+## Building from Source
-Due to the nature of advanced Rust programming, we will be spending a lot of time
-talking about *safety* and *guarantees*. In particular, a significant portion of
-the book will be dedicated to correctly writing and understanding Unsafe Rust.
+1. Make sure you have installed the dependencies:
-[trpl]: https://doc.rust-lang.org/book/
-[The stack and heap]: https://doc.rust-lang.org/book/the-stack-and-the-heap.html
-[Basic Rust]: https://doc.rust-lang.org/book/syntax-and-semantics.html
+ * `g++` 4.7 or `clang++` 3.x
+ * `python` 2.6 or later (but not 3.x)
+ * GNU `make` 3.81 or later
+ * `curl`
+ * `git`
+
+2. Clone the [source] with `git`:
+
+ ```sh
+ $ git clone https://github.com/rust-lang/rust.git
+ $ cd rust
+ ```
+
+[source]: https://github.com/rust-lang/rust
+
+3. Build and install:
+
+ ```sh
+ $ ./configure
+ $ make && make install
+ ```
+
+ > ***Note:*** You may need to use `sudo make install` if you do not
+ > normally have permission to modify the destination directory. The
+ > install locations can be adjusted by passing a `--prefix` argument
+ > to `configure`. Various other options are also supported – pass
+ > `--help` for more information on them.
+
+ When complete, `make install` will place several programs into
+ `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
+ API-documentation tool. This install does not include [Cargo],
+ Rust's package manager, which you may also want to build.
+
+[Cargo]: https://github.com/rust-lang/cargo
+
+### Building on Windows
+
+[MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows:
+
+1. Grab the latest MSYS2 installer and go through the installer.
+
+2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
+ tools.
+
+ ```sh
+ # Update package mirrors (may be needed if you have a fresh install of MSYS2)
+ $ pacman -Sy pacman-mirrors
+
+ # Choose one based on platform:
+ $ pacman -S mingw-w64-i686-toolchain
+ $ pacman -S mingw-w64-x86_64-toolchain
+
+ $ pacman -S base-devel
+ ```
+
+3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
+ MSYS2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
+
+4. Navigate to Rust's source code, configure and build it:
+
+ ```sh
+ $ ./configure
+ $ make && make install
+ ```
+
+## Building Documentation
+
+If you’d like to build the documentation, it’s almost the same:
+
+```sh
+./configure
+$ make docs
+```
+
+Building the documentation requires building the compiler, so the above
+details will apply. Once you have the compiler built, you can
+
+```sh
+$ make docs NO_REBUILD=1
+```
+
+To make sure you don’t re-build the compiler because you made a change
+to some documentation.
+
+The generated documentation will appear in a top-level `doc` directory,
+created by the `make` rule.
+
+## Notes
+
+Since the Rust compiler is written in Rust, it must be built by a
+precompiled "snapshot" version of itself (made in an earlier state of
+development). As such, source builds require a connection to the Internet, to
+fetch snapshots, and an OS that can execute the available snapshot binaries.
+
+Snapshot binaries are currently built and tested on several platforms:
+
+| Platform \ Architecture | x86 | x86_64 |
+|--------------------------------|-----|--------|
+| Windows (7, 8, Server 2008 R2) | ✓ | ✓ |
+| Linux (2.6.18 or later) | ✓ | ✓ |
+| OSX (10.7 Lion or later) | ✓ | ✓ |
+
+You may find that other platforms work, but these are our officially
+supported build environments that are most likely to work.
+
+Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
+swap, it will take a very long time to build.
+
+There is more advice about hacking on Rust in [CONTRIBUTING.md].
+
+[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
+
+## Getting Help
+
+The Rust community congregates in a few places:
+
+* [Stack Overflow] - Direct questions about using the language.
+* [users.rust-lang.org] - General discussion and broader questions.
+* [/r/rust] - News and general discussion.
+
+[Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
+[/r/rust]: http://reddit.com/r/rust
+[users.rust-lang.org]: https://users.rust-lang.org/
+
+## Contributing
+
+To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
+
+Rust has an [IRC] culture and most real-time collaboration happens in a
+variety of channels on Mozilla's IRC network, irc.mozilla.org. The
+most popular channel is [#rust], a venue for general discussion about
+Rust, and a good place to ask for help.
+
+[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
+[#rust]: irc://irc.mozilla.org/rust
+
+## License
+
+Rust is primarily distributed under the terms of both the MIT license
+and the Apache License (Version 2.0), with portions covered by various
+BSD-like licenses.
+
+See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.
projects / rust.git / blobdiff