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