1 <a href = "https://www.rust-lang.org/">
2 <img width = "90%" height = "auto" src = "https://img.shields.io/badge/Rust-Programming%20Language-black?style=flat&logo=rust" alt = "The Rust Programming Language">
5 This is the main source code repository for [Rust]. It contains the compiler,
6 standard library, and documentation.
8 [Rust]: https://www.rust-lang.org
12 Read ["Installation"] from [The Book].
14 ["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
15 [The Book]: https://doc.rust-lang.org/book/index.html
17 ## Installing from Source
19 _Note: If you wish to contribute to the compiler, you should read [this
20 chapter][rustcguidebuild] of the rustc-dev-guide instead of this section._
22 The Rust build system uses a Python script called `x.py` to build the compiler,
23 which manages the bootstrapping process. More information about it can be found
24 by running `./x.py --help` or reading the [rustc dev guide][rustcguidebuild].
26 [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html
28 ### Building on a Unix-like system
29 1. Make sure you have installed the dependencies:
31 * `g++` 5.1 or later or `clang++` 3.5 or later
33 * GNU `make` 3.81 or later
34 * `cmake` 3.4.3 or later
37 * `ssl` which comes in `libssl-dev` or `openssl-devel`
38 * `pkg-config` if you are compiling on Linux and targeting Linux
40 2. Clone the [source] with `git`:
43 $ git clone https://github.com/rust-lang/rust.git
47 [source]: https://github.com/rust-lang/rust
49 3. Configure the build settings:
51 The Rust build system uses a file named `config.toml` in the root of the
52 source tree to determine various configuration settings for the build.
53 Copy the default `config.toml.example` to `config.toml` to get started.
56 $ cp config.toml.example config.toml
59 If you plan to use `x.py install` to create an installation, it is recommended
60 that you set the `prefix` value in the `[install]` section to a directory.
62 Create install directory if you are not installing in default directory
67 $ ./x.py build && ./x.py install
70 When complete, `./x.py install` will place several programs into
71 `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
72 API-documentation tool. This install does not include [Cargo],
73 Rust's package manager. To build and install Cargo, you may
74 run `./x.py install cargo` or set the `build.extended` key in
75 `config.toml` to `true` to build and install all tools.
77 [Cargo]: https://github.com/rust-lang/cargo
79 ### Building on Windows
81 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
82 Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
83 you need depends largely on what C/C++ libraries you want to interoperate with:
84 for interop with software produced by Visual Studio use the MSVC build of Rust;
85 for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
90 [MSYS2][msys2] can be used to easily build Rust on Windows:
92 [msys2]: https://msys2.github.io/
94 1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
96 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
97 MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit
98 Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
99 -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
101 3. From this terminal, install the required tools:
104 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
105 $ pacman -Sy pacman-mirrors
107 # Install build tools needed for Rust. If you're building a 32-bit compiler,
108 # then replace "x86_64" below with "i686". If you've already got git, python,
109 # or CMake installed and in PATH you can remove them from this list. Note
110 # that it is important that you do **not** use the 'python2' and 'cmake'
111 # packages from the 'msys2' subsystem. The build has historically been known
112 # to fail with these packages.
117 mingw-w64-x86_64-python \
118 mingw-w64-x86_64-cmake \
122 4. Navigate to Rust's source code (or clone it), then build it:
125 $ ./x.py build && ./x.py install
130 MSVC builds of Rust additionally require an installation of Visual Studio 2017
131 (or later) so `rustc` can use its linker. The simplest way is to get the
132 [Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
134 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
136 (If you're installing cmake yourself, be careful that “C++ CMake tools for
137 Windows” doesn't get included under “Individual components”.)
139 With these dependencies installed, you can build the compiler in a `cmd.exe`
146 Currently, building Rust only works with some known versions of Visual Studio. If
147 you have a more recent version installed and the build system doesn't understand,
148 you may need to force rustbuild to use an older version. This can be done
149 by manually calling the appropriate vcvars file before running the bootstrap.
152 > CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
156 ### Building rustc with older host toolchains
157 It is still possible to build Rust with the older toolchain versions listed below, but only if the
158 LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN option is set to true in the config.toml file.
163 * Visual Studio 2015 (Update 3)
165 Toolchain versions older than what is listed above cannot be used to build rustc.
167 #### Specifying an ABI
169 Each specific ABI can also be used from either environment (for example, using
170 the GNU ABI in PowerShell) by using an explicit build triple. The available
171 Windows build triples are:
172 - GNU ABI (using GCC)
173 - `i686-pc-windows-gnu`
174 - `x86_64-pc-windows-gnu`
176 - `i686-pc-windows-msvc`
177 - `x86_64-pc-windows-msvc`
179 The build triple can be specified by either specifying `--build=<triple>` when
180 invoking `x.py` commands, or by copying the `config.toml` file (as described
181 in [Installing From Source](#installing-from-source)), and modifying the
182 `build` option under the `[build]` section.
184 ### Configure and Make
186 While it's not the recommended build system, this project also provides a
187 configure script and makefile (the latter of which just invokes `x.py`).
191 $ make && sudo make install
194 When using the configure script, the generated `config.mk` file may override the
195 `config.toml` file. To go back to the `config.toml` file, delete the generated
198 ## Building Documentation
200 If you’d like to build the documentation, it’s almost the same:
206 The generated documentation will appear under `doc` in the `build` directory for
207 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
208 `build\x86_64-pc-windows-msvc\doc`.
212 Since the Rust compiler is written in Rust, it must be built by a
213 precompiled "snapshot" version of itself (made in an earlier stage of
214 development). As such, source builds require a connection to the Internet, to
215 fetch snapshots, and an OS that can execute the available snapshot binaries.
217 Snapshot binaries are currently built and tested on several platforms:
219 | Platform / Architecture | x86 | x86_64 |
220 |----------------------------|-----|--------|
221 | Windows (7, 8, 10, ...) | ✓ | ✓ |
222 | Linux (2.6.18 or later) | ✓ | ✓ |
223 | macOS (10.7 Lion or later) | ✓ | ✓ |
225 You may find that other platforms work, but these are our officially
226 supported build environments that are most likely to work.
228 There is more advice about hacking on Rust in [CONTRIBUTING.md].
230 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
234 The Rust community congregates in a few places:
236 * [Stack Overflow] - Direct questions about using the language.
237 * [users.rust-lang.org] - General discussion and broader questions.
238 * [/r/rust] - News and general discussion.
240 [Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
241 [/r/rust]: https://reddit.com/r/rust
242 [users.rust-lang.org]: https://users.rust-lang.org/
246 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
248 Most real-time collaboration happens in a variety of channels on the
249 [Rust Discord server][rust-discord], with channels dedicated for getting help,
250 community, documentation, and all major contribution areas in the Rust ecosystem.
251 A good place to ask for help would be the #help channel.
253 The [rustc dev guide] might be a good place to start if you want to find out how
254 various parts of the compiler work.
256 Also, you may find the [rustdocs for the compiler itself][rustdocs] useful.
258 [rust-discord]: https://discord.gg/rust-lang
259 [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/about-this-guide.html
260 [rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
264 Rust is primarily distributed under the terms of both the MIT license
265 and the Apache License (Version 2.0), with portions covered by various
268 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
269 [COPYRIGHT](COPYRIGHT) for details.
273 The Rust programming language is an open source, community project governed
274 by a core team. It is also sponsored by the Mozilla Foundation (“Mozilla”),
275 which owns and protects the Rust and Cargo trademarks and logos
276 (the “Rust Trademarks”).
278 If you want to use these names or brands, please read the [media guide][media-guide].
280 Third-party logos may be subject to third-party copyrights and trademarks. See
281 [Licenses][policies-licenses] for details.
283 [media-guide]: https://www.rust-lang.org/policies/media-guide
284 [policies-licenses]: https://www.rust-lang.org/policies/licenses