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.
11 You can ask for help in the [#new members Zulip stream][new-members].**
13 [new-members]: https://rust-lang.zulipchat.com/#narrow/stream/122652-new-members
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. It lives at the root of the project.
27 The `x.py` command can be run directly on most systems in the following format:
30 ./x.py <subcommand> [flags]
33 This is how the documentation and examples assume you are running `x.py`.
35 Systems such as Ubuntu 20.04 LTS do not create the necessary `python` command by default when Python is installed that allows `x.py` to be run directly. In that case, you can either create a symlink for `python` (Ubuntu provides the `python-is-python3` package for this), or run `x.py` using Python itself:
39 python3 x.py <subcommand> [flags]
42 python2.7 x.py <subcommand> [flags]
45 More information about `x.py` can be found
46 by running it with the `--help` flag or reading the [rustc dev guide][rustcguidebuild].
48 [gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
49 [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html
51 ### Building on a Unix-like system
52 1. Make sure you have installed the dependencies:
54 * `g++` 5.1 or later or `clang++` 3.5 or later
56 * GNU `make` 3.81 or later
57 * `cmake` 3.13.4 or later
61 * `ssl` which comes in `libssl-dev` or `openssl-devel`
62 * `pkg-config` if you are compiling on Linux and targeting Linux
64 2. Clone the [source] with `git`:
67 git clone https://github.com/rust-lang/rust.git
71 [source]: https://github.com/rust-lang/rust
73 3. Configure the build settings:
75 The Rust build system uses a file named `config.toml` in the root of the
76 source tree to determine various configuration settings for the build.
77 Copy the default `config.toml.example` to `config.toml` to get started.
80 cp config.toml.example config.toml
83 If you plan to use `x.py install` to create an installation, it is recommended
84 that you set the `prefix` value in the `[install]` section to a directory.
86 Create an install directory if you are not installing in the default directory.
91 ./x.py build && ./x.py install
94 When complete, `./x.py install` will place several programs into
95 `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
96 API-documentation tool. This install does not include [Cargo],
97 Rust's package manager. To build and install Cargo, you may
98 run `./x.py install cargo` or set the `build.extended` key in
99 `config.toml` to `true` to build and install all tools.
101 [Cargo]: https://github.com/rust-lang/cargo
103 ### Building on Windows
105 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
106 Visual Studio and the GNU ABI used by the GCC toolchain. Which version of Rust
107 you need depends largely on what C/C++ libraries you want to interoperate with.
108 Use the MSVC build of Rust to interop with software produced by Visual Studio and
109 the GNU build to interop with GNU software built using the MinGW/MSYS2 toolchain.
113 [MSYS2][msys2] can be used to easily build Rust on Windows:
115 [msys2]: https://www.msys2.org/
117 1. Download the latest [MSYS2 installer][msys2] and go through the installer.
119 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from the MSYS2 installation
120 directory (e.g. `C:\msys64`), depending on whether you want 32-bit or 64-bit
121 Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
122 -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
124 3. From this terminal, install the required tools:
127 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
128 pacman -Sy pacman-mirrors
130 # Install build tools needed for Rust. If you're building a 32-bit compiler,
131 # then replace "x86_64" below with "i686". If you've already got git, python,
132 # or CMake installed and in PATH you can remove them from this list. Note
133 # that it is important that you do **not** use the 'python2', 'cmake' and 'ninja'
134 # packages from the 'msys2' subsystem. The build has historically been known
135 # to fail with these packages.
140 mingw-w64-x86_64-python \
141 mingw-w64-x86_64-cmake \
142 mingw-w64-x86_64-gcc \
143 mingw-w64-x86_64-ninja
146 4. Navigate to Rust's source code (or clone it), then build it:
149 ./x.py build && ./x.py install
154 MSVC builds of Rust additionally require an installation of Visual Studio 2017
155 (or later) so `rustc` can use its linker. The simplest way is to get
156 [Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
158 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
160 (If you're installing cmake yourself, be careful that “C++ CMake tools for
161 Windows” doesn't get included under “Individual components”.)
163 With these dependencies installed, you can build the compiler in a `cmd.exe`
170 Right now, building Rust only works with some known versions of Visual Studio. If
171 you have a more recent version installed and the build system doesn't understand,
172 you may need to force rustbuild to use an older version. This can be done
173 by manually calling the appropriate vcvars file before running the bootstrap.
176 CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
180 #### Specifying an ABI
182 Each specific ABI can also be used from either environment (for example, using
183 the GNU ABI in PowerShell) by using an explicit build triple. The available
184 Windows build triples are:
185 - GNU ABI (using GCC)
186 - `i686-pc-windows-gnu`
187 - `x86_64-pc-windows-gnu`
189 - `i686-pc-windows-msvc`
190 - `x86_64-pc-windows-msvc`
192 The build triple can be specified by either specifying `--build=<triple>` when
193 invoking `x.py` commands, or by copying the `config.toml` file (as described
194 in [Installing From Source](#installing-from-source)), and modifying the
195 `build` option under the `[build]` section.
197 ### Configure and Make
199 While it's not the recommended build system, this project also provides a
200 configure script and makefile (the latter of which just invokes `x.py`).
204 make && sudo make install
207 When using the configure script, the generated `config.mk` file may override the
208 `config.toml` file. To go back to the `config.toml` file, delete the generated
211 ## Building Documentation
213 If you’d like to build the documentation, it’s almost the same:
219 The generated documentation will appear under `doc` in the `build` directory for
220 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
221 `build\x86_64-pc-windows-msvc\doc`.
225 Since the Rust compiler is written in Rust, it must be built by a
226 precompiled "snapshot" version of itself (made in an earlier stage of
227 development). As such, source builds require an Internet connection to
228 fetch snapshots, and an OS that can execute the available snapshot binaries.
230 Snapshot binaries are currently built and tested on several platforms:
232 | Platform / Architecture | x86 | x86_64 |
233 |---------------------------------------------|-----|--------|
234 | Windows (7, 8, 10, ...) | ✓ | ✓ |
235 | Linux (kernel 3.2, glibc 2.17 or later) | ✓ | ✓ |
236 | macOS (10.7 Lion or later) | (\*) | ✓ |
238 (\*): Apple dropped support for running 32-bit binaries starting from macOS 10.15 and iOS 11.
239 Due to this decision from Apple, the targets are no longer useful to our users.
240 Please read [our blog post][macx32] for more info.
242 [macx32]: https://blog.rust-lang.org/2020/01/03/reducing-support-for-32-bit-apple-targets.html
244 You may find that other platforms work, but these are our officially
245 supported build environments that are most likely to work.
249 The Rust community congregates in a few places:
251 * [Stack Overflow] - Direct questions about using the language.
252 * [users.rust-lang.org] - General discussion and broader questions.
253 * [/r/rust] - News and general discussion.
255 [Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
256 [/r/rust]: https://reddit.com/r/rust
257 [users.rust-lang.org]: https://users.rust-lang.org/
261 If you are interested in contributing to the Rust project, please take a look
262 at the [Getting Started][gettingstarted] guide in the [rustc-dev-guide].
264 [rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org
268 Rust is primarily distributed under the terms of both the MIT license
269 and the Apache License (Version 2.0), with portions covered by various
272 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
273 [COPYRIGHT](COPYRIGHT) for details.
277 [The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
278 trademarks and logos (the “Rust Trademarks”).
280 If you want to use these names or brands, please read the [media guide][media-guide].
282 Third-party logos may be subject to third-party copyrights and trademarks. See
283 [Licenses][policies-licenses] for details.
285 [rust-foundation]: https://foundation.rust-lang.org/
286 [media-guide]: https://www.rust-lang.org/policies/media-guide
287 [policies-licenses]: https://www.rust-lang.org/policies/licenses