1 # The Rust Programming Language
3 Rust is a fast systems programming language that guarantees
4 memory safety and offers painless concurrency ([no data races]).
5 It does not employ a garbage collector and has minimal runtime overhead.
7 This repo contains the code for the compiler (`rustc`), as well
8 as standard libraries, tools and documentation for Rust.
10 [no data races]: http://blog.rust-lang.org/2015/04/10/Fearless-Concurrency.html
14 Read ["Installing Rust"] from [The Book].
16 ["Installing Rust"]: https://doc.rust-lang.org/book/installing-rust.html
17 [The Book]: https://doc.rust-lang.org/book/index.html
19 ## Building from Source
21 1. Make sure you have installed the dependencies:
23 * `g++` 4.7 or `clang++` 3.x
24 * `python` 2.6 or later (but not 3.x)
25 * GNU `make` 3.81 or later
29 2. Clone the [source] with `git`:
32 $ git clone https://github.com/rust-lang/rust.git
36 [source]: https://github.com/rust-lang/rust
42 $ make && make install
45 > ***Note:*** You may need to use `sudo make install` if you do not
46 > normally have permission to modify the destination directory. The
47 > install locations can be adjusted by passing a `--prefix` argument
48 > to `configure`. Various other options are also supported – pass
49 > `--help` for more information on them.
51 When complete, `make install` will place several programs into
52 `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
53 API-documentation tool. This install does not include [Cargo],
54 Rust's package manager, which you may also want to build.
56 [Cargo]: https://github.com/rust-lang/cargo
58 ### Building on Windows
60 [MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows:
62 1. Grab the latest MSYS2 installer and go through the installer.
64 2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
68 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
69 $ pacman -Sy pacman-mirrors
71 # Choose one based on platform:
72 $ pacman -S mingw-w64-i686-toolchain
73 $ pacman -S mingw-w64-x86_64-toolchain
75 $ pacman -S base-devel
78 3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
79 MSYS2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
81 4. Navigate to Rust's source code, configure and build it:
85 $ make && make install
88 ## Building Documentation
90 If you’d like to build the documentation, it’s almost the same:
97 Building the documentation requires building the compiler, so the above
98 details will apply. Once you have the compiler built, you can
101 $ make docs NO_REBUILD=1
104 To make sure you don’t re-build the compiler because you made a change
105 to some documentation.
107 The generated documentation will appear in a top-level `doc` directory,
108 created by the `make` rule.
112 Since the Rust compiler is written in Rust, it must be built by a
113 precompiled "snapshot" version of itself (made in an earlier state of
114 development). As such, source builds require a connection to the Internet, to
115 fetch snapshots, and an OS that can execute the available snapshot binaries.
117 Snapshot binaries are currently built and tested on several platforms:
119 | Platform \ Architecture | x86 | x86_64 |
120 |--------------------------------|-----|--------|
121 | Windows (7, 8, Server 2008 R2) | ✓ | ✓ |
122 | Linux (2.6.18 or later) | ✓ | ✓ |
123 | OSX (10.7 Lion or later) | ✓ | ✓ |
125 You may find that other platforms work, but these are our officially
126 supported build environments that are most likely to work.
128 Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
129 swap, it will take a very long time to build.
131 There is more advice about hacking on Rust in [CONTRIBUTING.md].
133 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
137 The Rust community congregates in a few places:
139 * [Stack Overflow] - Direct questions about using the language.
140 * [users.rust-lang.org] - General discussion and broader questions.
141 * [/r/rust] - News and general discussion.
143 [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
144 [/r/rust]: http://reddit.com/r/rust
145 [users.rust-lang.org]: https://users.rust-lang.org/
149 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
151 Rust has an [IRC] culture and most real-time collaboration happens in a
152 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
153 most popular channel is [#rust], a venue for general discussion about
154 Rust, and a good place to ask for help.
156 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
157 [#rust]: irc://irc.mozilla.org/rust
161 Rust is primarily distributed under the terms of both the MIT license
162 and the Apache License (Version 2.0), with portions covered by various
165 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.