1 # The Rust Programming Language
3 This is the main source code repository for [Rust]. It contains the compiler,
4 standard library, and documentation.
6 [Rust]: https://www.rust-lang.org
9 [quick-start]: #quick-start
11 Read ["Installation"] from [The Book].
13 ["Installation"]: https://doc.rust-lang.org/book/second-edition/ch01-01-installation.html
14 [The Book]: https://doc.rust-lang.org/book/index.html
16 ## Building from Source
17 [building-from-source]: #building-from-source
20 1. Make sure you have installed the dependencies:
22 * `g++` 4.7 or later or `clang++` 3.x or later
23 * `python` 2.7 (but not 3.x)
24 * GNU `make` 3.81 or later
25 * `cmake` 3.4.3 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
41 $ ./x.py build && sudo ./x.py install
44 > ***Note:*** Install locations can be adjusted by copying the config file
45 > from `./config.toml.example` to `./config.toml`, and
46 > adjusting the `prefix` option under `[install]`. Various other options, such
47 > as enabling debug information, are also supported, and are documented in
50 When complete, `sudo ./x.py install` will place several programs into
51 `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
52 API-documentation tool. This install does not include [Cargo],
53 Rust's package manager, which you may also want to build.
55 [Cargo]: https://github.com/rust-lang/cargo
57 ### Building on Windows
58 [building-on-windows]: #building-on-windows
60 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
61 Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
62 you need depends largely on what C/C++ libraries you want to interoperate with:
63 for interop with software produced by Visual Studio use the MSVC build of Rust;
64 for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
68 [windows-mingw]: #windows-mingw
70 [MSYS2][msys2] can be used to easily build Rust on Windows:
72 [msys2]: https://msys2.github.io/
74 1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
76 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
77 MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit
78 Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
79 -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
81 3. From this terminal, install the required tools:
84 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
85 $ pacman -Sy pacman-mirrors
87 # Install build tools needed for Rust. If you're building a 32-bit compiler,
88 # then replace "x86_64" below with "i686". If you've already got git, python,
89 # or CMake installed and in PATH you can remove them from this list. Note
90 # that it is important that you do **not** use the 'python2' and 'cmake'
91 # packages from the 'msys2' subsystem. The build has historically been known
92 # to fail with these packages.
97 mingw-w64-x86_64-python2 \
98 mingw-w64-x86_64-cmake \
102 4. Navigate to Rust's source code (or clone it), then build it:
105 $ ./x.py build && ./x.py install
109 [windows-msvc]: #windows-msvc
111 MSVC builds of Rust additionally require an installation of Visual Studio 2013
112 (or later) so `rustc` can use its linker. Make sure to check the “C++ tools”
115 With these dependencies installed, you can build the compiler in a `cmd.exe`
122 Currently building Rust only works with some known versions of Visual Studio. If
123 you have a more recent version installed the build system doesn't understand
124 then you may need to force rustbuild to use an older version. This can be done
125 by manually calling the appropriate vcvars file before running the bootstrap.
128 CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat"
132 #### Specifying an ABI
133 [specifying-an-abi]: #specifying-an-abi
135 Each specific ABI can also be used from either environment (for example, using
136 the GNU ABI in powershell) by using an explicit build triple. The available
137 Windows build triples are:
138 - GNU ABI (using GCC)
139 - `i686-pc-windows-gnu`
140 - `x86_64-pc-windows-gnu`
142 - `i686-pc-windows-msvc`
143 - `x86_64-pc-windows-msvc`
145 The build triple can be specified by either specifying `--build=<triple>` when
146 invoking `x.py` commands, or by copying the `config.toml` file (as described
147 in Building From Source), and modifying the `build` option under the `[build]`
150 ### Configure and Make
151 [configure-and-make]: #configure-and-make
153 While it's not the recommended build system, this project also provides a
154 configure script and makefile (the latter of which just invokes `x.py`).
158 $ make && sudo make install
161 When using the configure script, the generated `config.mk` file may override the
162 `config.toml` file. To go back to the `config.toml` file, delete the generated
165 ## Building Documentation
166 [building-documentation]: #building-documentation
168 If you’d like to build the documentation, it’s almost the same:
174 The generated documentation will appear under `doc` in the `build` directory for
175 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
176 `build\x86_64-pc-windows-msvc\doc`.
181 Since the Rust compiler is written in Rust, it must be built by a
182 precompiled "snapshot" version of itself (made in an earlier state of
183 development). As such, source builds require a connection to the Internet, to
184 fetch snapshots, and an OS that can execute the available snapshot binaries.
186 Snapshot binaries are currently built and tested on several platforms:
188 | Platform / Architecture | x86 | x86_64 |
189 |--------------------------------|-----|--------|
190 | Windows (7, 8, Server 2008 R2) | ✓ | ✓ |
191 | Linux (2.6.18 or later) | ✓ | ✓ |
192 | OSX (10.7 Lion or later) | ✓ | ✓ |
194 You may find that other platforms work, but these are our officially
195 supported build environments that are most likely to work.
197 Rust currently needs between 600MiB and 1.5GiB of RAM to build, depending on platform.
198 If it hits swap, it will take a very long time to build.
200 There is more advice about hacking on Rust in [CONTRIBUTING.md].
202 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
205 [getting-help]: #getting-help
207 The Rust community congregates in a few places:
209 * [Stack Overflow] - Direct questions about using the language.
210 * [users.rust-lang.org] - General discussion and broader questions.
211 * [/r/rust] - News and general discussion.
213 [Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
214 [/r/rust]: https://reddit.com/r/rust
215 [users.rust-lang.org]: https://users.rust-lang.org/
218 [contributing]: #contributing
220 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
222 Rust has an [IRC] culture and most real-time collaboration happens in a
223 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
224 most popular channel is [#rust], a venue for general discussion about
225 Rust. And a good place to ask for help would be [#rust-beginners].
227 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
228 [#rust]: irc://irc.mozilla.org/rust
229 [#rust-beginners]: irc://irc.mozilla.org/rust-beginners
234 Rust is primarily distributed under the terms of both the MIT license
235 and the Apache License (Version 2.0), with portions covered by various
238 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
239 [COPYRIGHT](COPYRIGHT) for details.