1 # The Rust Programming Language
3 This is the main source code repository for [Rust]. It contains the compiler, standard library,
6 [Rust]: https://www.rust-lang.org
10 Read ["Installing Rust"] from [The Book].
12 ["Installing Rust"]: https://doc.rust-lang.org/book/getting-started.html#installing-rust
13 [The Book]: https://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 later or `clang++` 3.x
20 * `python` 2.7 (but not 3.x)
21 * GNU `make` 3.81 or later
22 * `cmake` 2.8.8 or later
26 2. Clone the [source] with `git`:
29 $ git clone https://github.com/rust-lang/rust.git
33 [source]: https://github.com/rust-lang/rust
39 $ make && make install
42 > ***Note:*** You may need to use `sudo make install` if you do not
43 > normally have permission to modify the destination directory. The
44 > install locations can be adjusted by passing a `--prefix` argument
45 > to `configure`. Various other options are also supported – pass
46 > `--help` for more information on them.
48 When complete, `make install` will place several programs into
49 `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
50 API-documentation tool. This install does not include [Cargo],
51 Rust's package manager, which you may also want to build.
53 [Cargo]: https://github.com/rust-lang/cargo
55 ### Building on Windows
57 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
58 Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
59 you need depends largely on what C/C++ libraries you want to interoperate with:
60 for interop with software produced by Visual Studio use the MSVC build of Rust;
61 for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
67 [MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows:
69 1. Grab the latest MSYS2 installer and go through the installer.
71 2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
75 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
76 $ pacman -Sy pacman-mirrors
80 here](http://mingw-w64.org/doku.php/download/mingw-builds), and choose the
81 `version=4.9.x,threads=win32,exceptions=dwarf/seh` flavor when installing. Also, make sure to install to a path without spaces in it. After installing,
82 add its `bin` directory to your `PATH`. This is due to [#28260](https://github.com/rust-lang/rust/issues/28260), in the future,
83 installing from pacman should be just fine.
86 # Make git available in MSYS2 (if not already available on path)
89 $ pacman -S base-devel
92 3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
93 MSYS2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
94 (As of the latest version of MSYS2 you have to run `msys2_shell.cmd -mingw32`
95 or `msys2_shell.cmd -mingw64` from the command line instead)
97 4. Navigate to Rust's source code, configure and build it:
101 $ make && make install
106 MSVC builds of Rust additionally require an installation of Visual Studio 2013
107 (or later) so `rustc` can use its linker. Make sure to check the “C++ tools”
108 option. In addition, `cmake` needs to be installed to build LLVM.
110 With these dependencies installed, the build takes two steps:
114 $ make && make install
117 ## Building Documentation
119 If you’d like to build the documentation, it’s almost the same:
126 Building the documentation requires building the compiler, so the above
127 details will apply. Once you have the compiler built, you can
130 $ make docs NO_REBUILD=1
133 To make sure you don’t re-build the compiler because you made a change
134 to some documentation.
136 The generated documentation will appear in a top-level `doc` directory,
137 created by the `make` rule.
141 Since the Rust compiler is written in Rust, it must be built by a
142 precompiled "snapshot" version of itself (made in an earlier state of
143 development). As such, source builds require a connection to the Internet, to
144 fetch snapshots, and an OS that can execute the available snapshot binaries.
146 Snapshot binaries are currently built and tested on several platforms:
148 | Platform \ Architecture | x86 | x86_64 |
149 |--------------------------------|-----|--------|
150 | Windows (7, 8, Server 2008 R2) | ✓ | ✓ |
151 | Linux (2.6.18 or later) | ✓ | ✓ |
152 | OSX (10.7 Lion or later) | ✓ | ✓ |
154 You may find that other platforms work, but these are our officially
155 supported build environments that are most likely to work.
157 Rust currently needs between 600MiB and 1.5GiB to build, depending on platform. If it hits
158 swap, it will take a very long time to build.
160 There is more advice about hacking on Rust in [CONTRIBUTING.md].
162 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
166 The Rust community congregates in a few places:
168 * [Stack Overflow] - Direct questions about using the language.
169 * [users.rust-lang.org] - General discussion and broader questions.
170 * [/r/rust] - News and general discussion.
172 [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
173 [/r/rust]: http://reddit.com/r/rust
174 [users.rust-lang.org]: https://users.rust-lang.org/
178 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
180 Rust has an [IRC] culture and most real-time collaboration happens in a
181 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
182 most popular channel is [#rust], a venue for general discussion about
183 Rust. And a good place to ask for help would be [#rust-beginners].
185 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
186 [#rust]: irc://irc.mozilla.org/rust
187 [#rust-beginners]: irc://irc.mozilla.org/rust-beginners
191 Rust is primarily distributed under the terms of both the MIT license
192 and the Apache License (Version 2.0), with portions covered by various
195 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.