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
8 **Note: this README is for _users_ rather than _contributors_.
9 If you wish to _contribute_ to the compiler, you should read the
10 [Getting Started][gettingstarted] section of the rustc-dev-guide instead.**
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 The Rust build system uses a Python script called `x.py` to build the compiler,
22 which manages the bootstrapping process. More information about it can be found
23 by running `./x.py --help` or reading the [rustc dev guide][rustcguidebuild].
25 [gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
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.13.4 or later
38 * `ssl` which comes in `libssl-dev` or `openssl-devel`
39 * `pkg-config` if you are compiling on Linux and targeting Linux
41 2. Clone the [source] with `git`:
44 git clone https://github.com/rust-lang/rust.git
48 [source]: https://github.com/rust-lang/rust
50 3. Configure the build settings:
52 The Rust build system uses a file named `config.toml` in the root of the
53 source tree to determine various configuration settings for the build.
54 Copy the default `config.toml.example` to `config.toml` to get started.
57 cp config.toml.example config.toml
60 If you plan to use `x.py install` to create an installation, it is recommended
61 that you set the `prefix` value in the `[install]` section to a directory.
63 Create install directory if you are not installing in default directory
68 ./x.py build && ./x.py install
71 When complete, `./x.py install` will place several programs into
72 `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
73 API-documentation tool. This install does not include [Cargo],
74 Rust's package manager. To build and install Cargo, you may
75 run `./x.py install cargo` or set the `build.extended` key in
76 `config.toml` to `true` to build and install all tools.
78 [Cargo]: https://github.com/rust-lang/cargo
80 ### Building on Windows
82 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
83 Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
84 you need depends largely on what C/C++ libraries you want to interoperate with:
85 for interop with software produced by Visual Studio use the MSVC build of Rust;
86 for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
91 [MSYS2][msys2] can be used to easily build Rust on Windows:
93 [msys2]: https://www.msys2.org/
95 1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
97 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
98 MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit
99 Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
100 -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
102 3. From this terminal, install the required tools:
105 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
106 pacman -Sy pacman-mirrors
108 # Install build tools needed for Rust. If you're building a 32-bit compiler,
109 # then replace "x86_64" below with "i686". If you've already got git, python,
110 # or CMake installed and in PATH you can remove them from this list. Note
111 # that it is important that you do **not** use the 'python2', 'cmake' and 'ninja'
112 # packages from the 'msys2' subsystem. The build has historically been known
113 # to fail with these packages.
118 mingw-w64-x86_64-python \
119 mingw-w64-x86_64-cmake \
120 mingw-w64-x86_64-gcc \
121 mingw-w64-x86_64-ninja
124 4. Navigate to Rust's source code (or clone it), then build it:
127 ./x.py build && ./x.py install
132 MSVC builds of Rust additionally require an installation of Visual Studio 2017
133 (or later) so `rustc` can use its linker. The simplest way is to get the
134 [Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
136 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
138 (If you're installing cmake yourself, be careful that “C++ CMake tools for
139 Windows” doesn't get included under “Individual components”.)
141 With these dependencies installed, you can build the compiler in a `cmd.exe`
148 Currently, building Rust only works with some known versions of Visual Studio. If
149 you have a more recent version installed and the build system doesn't understand,
150 you may need to force rustbuild to use an older version. This can be done
151 by manually calling the appropriate vcvars file before running the bootstrap.
154 CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
158 #### Specifying an ABI
160 Each specific ABI can also be used from either environment (for example, using
161 the GNU ABI in PowerShell) by using an explicit build triple. The available
162 Windows build triples are:
163 - GNU ABI (using GCC)
164 - `i686-pc-windows-gnu`
165 - `x86_64-pc-windows-gnu`
167 - `i686-pc-windows-msvc`
168 - `x86_64-pc-windows-msvc`
170 The build triple can be specified by either specifying `--build=<triple>` when
171 invoking `x.py` commands, or by copying the `config.toml` file (as described
172 in [Installing From Source](#installing-from-source)), and modifying the
173 `build` option under the `[build]` section.
175 ### Configure and Make
177 While it's not the recommended build system, this project also provides a
178 configure script and makefile (the latter of which just invokes `x.py`).
182 make && sudo make install
185 When using the configure script, the generated `config.mk` file may override the
186 `config.toml` file. To go back to the `config.toml` file, delete the generated
189 ## Building Documentation
191 If you’d like to build the documentation, it’s almost the same:
197 The generated documentation will appear under `doc` in the `build` directory for
198 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
199 `build\x86_64-pc-windows-msvc\doc`.
203 Since the Rust compiler is written in Rust, it must be built by a
204 precompiled "snapshot" version of itself (made in an earlier stage of
205 development). As such, source builds require a connection to the Internet, to
206 fetch snapshots, and an OS that can execute the available snapshot binaries.
208 Snapshot binaries are currently built and tested on several platforms:
210 | Platform / Architecture | x86 | x86_64 |
211 |---------------------------------------------|-----|--------|
212 | Windows (7, 8, 10, ...) | ✓ | ✓ |
213 | Linux (kernel 2.6.32, glibc 2.11 or later) | ✓ | ✓ |
214 | macOS (10.7 Lion or later) | (\*) | ✓ |
216 (\*): Apple dropped support for running 32-bit binaries starting from macOS 10.15 and iOS 11.
217 Due to this decision from Apple, the targets are no longer useful to our users.
218 Please read [our blog post][macx32] for more info.
220 [macx32]: https://blog.rust-lang.org/2020/01/03/reducing-support-for-32-bit-apple-targets.html
222 You may find that other platforms work, but these are our officially
223 supported build environments that are most likely to work.
227 The Rust community congregates in a few places:
229 * [Stack Overflow] - Direct questions about using the language.
230 * [users.rust-lang.org] - General discussion and broader questions.
231 * [/r/rust] - News and general discussion.
233 [Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
234 [/r/rust]: https://reddit.com/r/rust
235 [users.rust-lang.org]: https://users.rust-lang.org/
239 If you are interested in contributing to the Rust project, please take a look
240 at the [Getting Started][gettingstarted] guide in the [rustc-dev-guide].
242 [rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org
246 Rust is primarily distributed under the terms of both the MIT license
247 and the Apache License (Version 2.0), with portions covered by various
250 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
251 [COPYRIGHT](COPYRIGHT) for details.
255 The Rust programming language is an open source, community project governed
256 by a core team. It is also sponsored by the Mozilla Foundation (“Mozilla”),
257 which owns and protects the Rust and Cargo trademarks and logos
258 (the “Rust Trademarks”).
260 If you want to use these names or brands, please read the [media guide][media-guide].
262 Third-party logos may be subject to third-party copyrights and trademarks. See
263 [Licenses][policies-licenses] for details.
265 [media-guide]: https://www.rust-lang.org/policies/media-guide
266 [policies-licenses]: https://www.rust-lang.org/policies/licenses