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 [CONTRIBUTING.md](CONTRIBUTING.md) instead.
13 Read ["Installation"] from [The Book].
15 ["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
16 [The Book]: https://doc.rust-lang.org/book/index.html
18 ## Installing from Source
20 The Rust build system uses a Python script called `x.py` to build the compiler,
21 which manages the bootstrapping process. It lives at the root of the project.
23 The `x.py` command can be run directly on most Unix systems in the following format:
26 ./x.py <subcommand> [flags]
29 This is how the documentation and examples assume you are running `x.py`. Some alternative ways are:
32 # On a Unix shell if you don't have the necessary `python3` command
33 ./x <subcommand> [flags]
35 # On the Windows Command Prompt (if .py files are configured to run Python)
36 x.py <subcommand> [flags]
38 # You can also run Python yourself, e.g.:
39 python x.py <subcommand> [flags]
42 More information about `x.py` can be found
43 by running it with the `--help` flag or reading the [rustc dev guide][rustcguidebuild].
45 [gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
46 [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html
50 Make sure you have installed the dependencies:
54 * A C compiler (when building for the host, `cc` is enough; cross-compiling may need additional compilers)
55 * `curl` (not needed on Windows)
56 * `pkg-config` if you are compiling on Linux and targeting Linux
57 * `libiconv` (already included with glibc on Debian-based distros)
59 To build cargo, you'll also need OpenSSL (`libssl-dev` or `openssl-devel` on most Unix distros).
61 If building LLVM from source, you'll need additional tools:
63 * `g++`, `clang++`, or MSVC with versions listed on
64 [LLVM's documentation](https://llvm.org/docs/GettingStarted.html#host-c-toolchain-both-compiler-and-standard-library)
65 * `ninja`, or GNU `make` 3.81 or later (ninja is recommended, especially on Windows)
66 * `cmake` 3.13.4 or later
67 * `libstdc++-static` may be required on some Linux distributions such as Fedora and Ubuntu
69 On tier 1 or tier 2 with host tools platforms, you can also choose to download LLVM by setting `llvm.download-ci-llvm = true`.
70 Otherwise, you'll need LLVM installed and `llvm-config` in your path.
71 See [the rustc-dev-guide for more info][sysllvm].
73 [sysllvm]: https://rustc-dev-guide.rust-lang.org/building/new-target.html#using-pre-built-llvm
76 ### Building on a Unix-like system
78 1. Clone the [source] with `git`:
81 git clone https://github.com/rust-lang/rust.git
85 [source]: https://github.com/rust-lang/rust
87 2. Configure the build settings:
89 The Rust build system uses a file named `config.toml` in the root of the
90 source tree to determine various configuration settings for the build.
91 Set up the defaults intended for distros to get started. You can see a full list of options
92 in `config.toml.example`.
95 printf 'profile = "user" \nchangelog-seen = 2 \n' > config.toml
98 If you plan to use `x.py install` to create an installation, it is recommended
99 that you set the `prefix` value in the `[install]` section to a directory.
101 3. Build and install:
104 ./x.py build && ./x.py install
107 When complete, `./x.py install` will place several programs into
108 `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
109 API-documentation tool. If you've set `profile = "user"` or `build.extended = true`, it will
110 also include [Cargo], Rust's package manager.
112 [Cargo]: https://github.com/rust-lang/cargo
114 ### Building on Windows
116 On Windows, we suggest using [winget] to install dependencies by running the following in a terminal:
119 winget install -e Python.Python.3
120 winget install -e Kitware.CMake
121 winget install -e Git.Git
124 Then edit your system's `PATH` variable and add: `C:\Program Files\CMake\bin`. See
125 [this guide on editing the system `PATH`](https://www.java.com/en/download/help/path.html) from the
128 [winget]: https://github.com/microsoft/winget-cli
130 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
131 Visual Studio and the GNU ABI used by the GCC toolchain. Which version of Rust
132 you need depends largely on what C/C++ libraries you want to interoperate with.
133 Use the MSVC build of Rust to interop with software produced by Visual Studio and
134 the GNU build to interop with GNU software built using the MinGW/MSYS2 toolchain.
138 [MSYS2][msys2] can be used to easily build Rust on Windows:
140 [msys2]: https://www.msys2.org/
142 1. Download the latest [MSYS2 installer][msys2] and go through the installer.
144 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from the MSYS2 installation
145 directory (e.g. `C:\msys64`), depending on whether you want 32-bit or 64-bit
146 Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
147 -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
149 3. From this terminal, install the required tools:
152 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
153 pacman -Sy pacman-mirrors
155 # Install build tools needed for Rust. If you're building a 32-bit compiler,
156 # then replace "x86_64" below with "i686". If you've already got git, python,
157 # or CMake installed and in PATH you can remove them from this list. Note
158 # that it is important that you do **not** use the 'python2', 'cmake' and 'ninja'
159 # packages from the 'msys2' subsystem. The build has historically been known
160 # to fail with these packages.
165 mingw-w64-x86_64-python \
166 mingw-w64-x86_64-cmake \
167 mingw-w64-x86_64-gcc \
168 mingw-w64-x86_64-ninja
171 4. Navigate to Rust's source code (or clone it), then build it:
174 ./x.py build && ./x.py install
179 MSVC builds of Rust additionally require an installation of Visual Studio 2017
180 (or later) so `rustc` can use its linker. The simplest way is to get
181 [Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
183 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
185 (If you're installing cmake yourself, be careful that “C++ CMake tools for
186 Windows” doesn't get included under “Individual components”.)
188 With these dependencies installed, you can build the compiler in a `cmd.exe`
195 Right now, building Rust only works with some known versions of Visual Studio. If
196 you have a more recent version installed and the build system doesn't understand,
197 you may need to force rustbuild to use an older version. This can be done
198 by manually calling the appropriate vcvars file before running the bootstrap.
201 CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
205 #### Specifying an ABI
207 Each specific ABI can also be used from either environment (for example, using
208 the GNU ABI in PowerShell) by using an explicit build triple. The available
209 Windows build triples are:
210 - GNU ABI (using GCC)
211 - `i686-pc-windows-gnu`
212 - `x86_64-pc-windows-gnu`
214 - `i686-pc-windows-msvc`
215 - `x86_64-pc-windows-msvc`
217 The build triple can be specified by either specifying `--build=<triple>` when
218 invoking `x.py` commands, or by creating a `config.toml` file (as described
219 in [Installing From Source](#installing-from-source)), and modifying the
220 `build` option under the `[build]` section.
222 ### Configure and Make
224 While it's not the recommended build system, this project also provides a
225 configure script and makefile (the latter of which just invokes `x.py`).
229 make && sudo make install
232 `configure` generates a `config.toml` which can also be used with normal `x.py` invocations.
234 ## Building Documentation
236 If you’d like to build the documentation, it’s almost the same:
242 The generated documentation will appear under `doc` in the `build` directory for
243 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
244 `build\x86_64-pc-windows-msvc\doc`.
248 Since the Rust compiler is written in Rust, it must be built by a
249 precompiled "snapshot" version of itself (made in an earlier stage of
250 development). As such, source builds require an Internet connection to
251 fetch snapshots, and an OS that can execute the available snapshot binaries.
253 See https://doc.rust-lang.org/nightly/rustc/platform-support.html for a list of supported platforms.
254 Only "host tools" platforms have a pre-compiled snapshot binary available; to compile for a platform
255 without host tools you must cross-compile.
257 You may find that other platforms work, but these are our officially
258 supported build environments that are most likely to work.
262 See https://www.rust-lang.org/community for a list of chat platforms and forums.
266 See [CONTRIBUTING.md](CONTRIBUTING.md).
270 Rust is primarily distributed under the terms of both the MIT license
271 and the Apache License (Version 2.0), with portions covered by various
274 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
275 [COPYRIGHT](COPYRIGHT) for details.
279 [The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
280 trademarks and logos (the “Rust Trademarks”).
282 If you want to use these names or brands, please read the [media guide][media-guide].
284 Third-party logos may be subject to third-party copyrights and trademarks. See
285 [Licenses][policies-licenses] for details.
287 [rust-foundation]: https://foundation.rust-lang.org/
288 [media-guide]: https://www.rust-lang.org/policies/media-guide
289 [policies-licenses]: https://www.rust-lang.org/policies/licenses