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