1 # The Rust Programming Language
3 Rust is a systems programming language that is fast, memory safe and
4 multithreaded, but does not employ a garbage collector or otherwise
5 impose significant runtime overhead.
7 This repo contains the code for `rustc`, the Rust compiler, as well
8 as standard libraries, tools and documentation for Rust.
12 Read ["Installing Rust"] from [The Book].
14 ["Installing Rust"]: http://doc.rust-lang.org/book/installing-rust.html
15 [The Book]: http://doc.rust-lang.org/book/index.html
17 ## Building from Source
19 1. Make sure you have installed the dependencies:
21 * `g++` 4.7 or `clang++` 3.x
22 * `python` 2.6 or later (but not 3.x)
23 * GNU `make` 3.81 or later
27 2. Clone the [source] with `git`:
30 $ git clone https://github.com/rust-lang/rust.git
34 [source]: https://github.com/rust-lang/rust
40 $ make && make install
43 > ***Note:*** You may need to use `sudo make install` if you do not
44 > normally have permission to modify the destination directory. The
45 > install locations can be adjusted by passing a `--prefix` argument
46 > to `configure`. Various other options are also supported – pass
47 > `--help` for more information on them.
49 When complete, `make install` will place several programs into
50 `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
51 API-documentation tool. This install does not include [Cargo],
52 Rust's package manager, which you may also want to build.
54 [Cargo]: https://github.com/rust-lang/cargo
56 ### Building on Windows
58 [MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows:
60 1. Grab the latest MSYS2 installer and go through the installer.
62 2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
66 # Choose one based on platform:
67 $ pacman -S mingw-w64-i686-toolchain
68 $ pacman -S mingw-w64-x86_64-toolchain
70 $ pacman -S base-devel
73 3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
74 MYSY2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
76 4. Navigate to Rust's source code, configure and build it:
80 $ make && make install
85 Since the Rust compiler is written in Rust, it must be built by a
86 precompiled "snapshot" version of itself (made in an earlier state of
87 development). As such, source builds require a connection to the Internet, to
88 fetch snapshots, and an OS that can execute the available snapshot binaries.
90 Snapshot binaries are currently built and tested on several platforms:
92 | Platform \ Architecture | x86 | x86_64 |
93 |--------------------------------|-----|--------|
94 | Windows (7, 8, Server 2008 R2) | ✓ | ✓ |
95 | Linux (2.6.18 or later) | ✓ | ✓ |
96 | OSX (10.7 Lion or later) | ✓ | ✓ |
98 You may find that other platforms work, but these are our officially
99 supported build environments that are most likely to work.
101 Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
102 swap, it will take a very long time to build.
104 There is more advice about hacking on Rust in [CONTRIBUTING.md].
106 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
110 The Rust community congregates in a few places:
112 * [Stack Overflow] - Direct questions about using the language.
113 * [users.rust-lang.org] - General discussion and broader questions.
114 * [/r/rust] - News and general discussion.
116 [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
117 [/r/rust]: http://reddit.com/r/rust
118 [users.rust-lang.org]: http://users.rust-lang.org/
122 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
124 Rust has an [IRC] culture and most real-time collaboration happens in a
125 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
126 most popular channel is [#rust], a venue for general discussion about
127 Rust, and a good place to ask for help.
129 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
130 [#rust]: irc://irc.mozilla.org/rust
134 Rust is primarily distributed under the terms of both the MIT license
135 and the Apache License (Version 2.0), with portions covered by various
138 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.