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
10 **Note: this README is for _users_ rather than _contributors_.**
14 Read ["Installation"] from [The Book].
16 ["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
17 [The Book]: https://doc.rust-lang.org/book/index.html
19 ## Installing from Source
21 **Note: If you wish to _contribute_ to the compiler, you should read the
22 [Getting Started][gettingstarted] of the rustc-dev-guide instead of this
25 The Rust build system uses a Python script called `x.py` to build the compiler,
26 which manages the bootstrapping process. More information about it can be found
27 by running `./x.py --help` or reading the [rustc dev guide][rustcguidebuild].
29 [gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
30 [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html
32 ### Building on a Unix-like system
33 1. Make sure you have installed the dependencies:
35 * `g++` 5.1 or later or `clang++` 3.5 or later
37 * GNU `make` 3.81 or later
38 * `cmake` 3.4.3 or later
42 * `ssl` which comes in `libssl-dev` or `openssl-devel`
43 * `pkg-config` if you are compiling on Linux and targeting Linux
45 2. Clone the [source] with `git`:
48 $ git clone https://github.com/rust-lang/rust.git
52 [source]: https://github.com/rust-lang/rust
54 3. Configure the build settings:
56 The Rust build system uses a file named `config.toml` in the root of the
57 source tree to determine various configuration settings for the build.
58 Copy the default `config.toml.example` to `config.toml` to get started.
61 $ cp config.toml.example config.toml
64 If you plan to use `x.py install` to create an installation, it is recommended
65 that you set the `prefix` value in the `[install]` section to a directory.
67 Create install directory if you are not installing in default directory
72 $ ./x.py build && ./x.py install
75 When complete, `./x.py install` will place several programs into
76 `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
77 API-documentation tool. This install does not include [Cargo],
78 Rust's package manager. To build and install Cargo, you may
79 run `./x.py install cargo` or set the `build.extended` key in
80 `config.toml` to `true` to build and install all tools.
82 [Cargo]: https://github.com/rust-lang/cargo
84 ### Building on Windows
86 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
87 Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
88 you need depends largely on what C/C++ libraries you want to interoperate with:
89 for interop with software produced by Visual Studio use the MSVC build of Rust;
90 for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
95 [MSYS2][msys2] can be used to easily build Rust on Windows:
97 [msys2]: https://msys2.github.io/
99 1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
101 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
102 MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit
103 Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
104 -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
106 3. From this terminal, install the required tools:
109 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
110 $ pacman -Sy pacman-mirrors
112 # Install build tools needed for Rust. If you're building a 32-bit compiler,
113 # then replace "x86_64" below with "i686". If you've already got git, python,
114 # or CMake installed and in PATH you can remove them from this list. Note
115 # that it is important that you do **not** use the 'python2', 'cmake' and 'ninja'
116 # packages from the 'msys2' subsystem. The build has historically been known
117 # to fail with these packages.
122 mingw-w64-x86_64-python \
123 mingw-w64-x86_64-cmake \
124 mingw-w64-x86_64-gcc \
125 mingw-w64-x86_64-ninja
128 4. Navigate to Rust's source code (or clone it), then build it:
131 $ ./x.py build && ./x.py install
136 MSVC builds of Rust additionally require an installation of Visual Studio 2017
137 (or later) so `rustc` can use its linker. The simplest way is to get the
138 [Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
140 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
142 (If you're installing cmake yourself, be careful that “C++ CMake tools for
143 Windows” doesn't get included under “Individual components”.)
145 With these dependencies installed, you can build the compiler in a `cmd.exe`
152 Currently, building Rust only works with some known versions of Visual Studio. If
153 you have a more recent version installed and the build system doesn't understand,
154 you may need to force rustbuild to use an older version. This can be done
155 by manually calling the appropriate vcvars file before running the bootstrap.
158 > CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
162 #### Specifying an ABI
164 Each specific ABI can also be used from either environment (for example, using
165 the GNU ABI in PowerShell) by using an explicit build triple. The available
166 Windows build triples are:
167 - GNU ABI (using GCC)
168 - `i686-pc-windows-gnu`
169 - `x86_64-pc-windows-gnu`
171 - `i686-pc-windows-msvc`
172 - `x86_64-pc-windows-msvc`
174 The build triple can be specified by either specifying `--build=<triple>` when
175 invoking `x.py` commands, or by copying the `config.toml` file (as described
176 in [Installing From Source](#installing-from-source)), and modifying the
177 `build` option under the `[build]` section.
179 ### Configure and Make
181 While it's not the recommended build system, this project also provides a
182 configure script and makefile (the latter of which just invokes `x.py`).
186 $ make && sudo make install
189 When using the configure script, the generated `config.mk` file may override the
190 `config.toml` file. To go back to the `config.toml` file, delete the generated
193 ## Building Documentation
195 If you’d like to build the documentation, it’s almost the same:
201 The generated documentation will appear under `doc` in the `build` directory for
202 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
203 `build\x86_64-pc-windows-msvc\doc`.
207 Since the Rust compiler is written in Rust, it must be built by a
208 precompiled "snapshot" version of itself (made in an earlier stage of
209 development). As such, source builds require a connection to the Internet, to
210 fetch snapshots, and an OS that can execute the available snapshot binaries.
212 Snapshot binaries are currently built and tested on several platforms:
214 | Platform / Architecture | x86 | x86_64 |
215 |---------------------------------------------|-----|--------|
216 | Windows (7, 8, 10, ...) | ✓ | ✓ |
217 | Linux (kernel 2.6.32, glibc 2.11 or later) | ✓ | ✓ |
218 | macOS (10.7 Lion or later) | (\*) | ✓ |
220 (\*): Apple dropped support for running 32-bit binaries starting from macOS 10.15 and iOS 11.
221 Due to this decision from Apple, the targets are no longer useful to our users.
222 Please read [our blog post][macx32] for more info.
224 [macx32]: https://blog.rust-lang.org/2020/01/03/reducing-support-for-32-bit-apple-targets.html
226 You may find that other platforms work, but these are our officially
227 supported build environments that are most likely to work.
231 The Rust community congregates in a few places:
233 * [Stack Overflow] - Direct questions about using the language.
234 * [users.rust-lang.org] - General discussion and broader questions.
235 * [/r/rust] - News and general discussion.
237 [Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
238 [/r/rust]: https://reddit.com/r/rust
239 [users.rust-lang.org]: https://users.rust-lang.org/
243 If you are interested in contributing to the Rust project, please take a look
244 at the [Getting Started][gettingstarted] guide in the [rustc-dev-guide].
248 Rust is primarily distributed under the terms of both the MIT license
249 and the Apache License (Version 2.0), with portions covered by various
252 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
253 [COPYRIGHT](COPYRIGHT) for details.
257 The Rust programming language is an open source, community project governed
258 by a core team. It is also sponsored by the Mozilla Foundation (“Mozilla”),
259 which owns and protects the Rust and Cargo trademarks and logos
260 (the “Rust Trademarks”).
262 If you want to use these names or brands, please read the [media guide][media-guide].
264 Third-party logos may be subject to third-party copyrights and trademarks. See
265 [Licenses][policies-licenses] for details.
267 [media-guide]: https://www.rust-lang.org/policies/media-guide
268 [policies-licenses]: https://www.rust-lang.org/policies/licenses