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
10 Read ["Installation"] from [The Book].
12 ["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
13 [The Book]: https://doc.rust-lang.org/book/index.html
15 ## Installing from Source
17 _Note: If you wish to contribute to the compiler, you should read [this
18 chapter][rustcguidebuild] of the rustc-guide instead of this section._
20 The Rust build system has a Python script called `x.py` to bootstrap building
21 the compiler. More information about it may be found by running `./x.py --help`
22 or reading the [rustc guide][rustcguidebuild].
24 [rustcguidebuild]: https://rust-lang.github.io/rustc-guide/building/how-to-build-and-run.html
27 1. Make sure you have installed the dependencies:
29 * `g++` 5.1 or later or `clang++` 3.5 or later
30 * `python` 2.7 (but not 3.x)
31 * GNU `make` 3.81 or later
32 * `cmake` 3.4.3 or later
35 * `ssl` which comes in `libssl-dev` or `openssl-devel`
36 * `pkg-config` if you are compiling on Linux and targeting Linux
38 2. Clone the [source] with `git`:
41 $ git clone https://github.com/rust-lang/rust.git
45 [source]: https://github.com/rust-lang/rust
47 3. Configure the build settings:
49 The Rust build system uses a file named `config.toml` in the root of the
50 source tree to determine various configuration settings for the build.
51 Copy the default `config.toml.example` to `config.toml` to get started.
54 $ cp config.toml.example config.toml
57 It is recommended that if you plan to use the Rust build system to create
58 an installation (using `./x.py install`) that you set the `prefix` value
59 in the `[install]` section to a directory that you have write permissions.
61 Create install directory if you are not installing in default directory
66 $ ./x.py build && ./x.py install
69 When complete, `./x.py install` will place several programs into
70 `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
71 API-documentation tool. This install does not include [Cargo],
72 Rust's package manager. To build and install Cargo, you may
73 run `./x.py install cargo` or set the `build.extended` key in
74 `config.toml` to `true` to build and install all tools.
76 [Cargo]: https://github.com/rust-lang/cargo
78 ### Building on Windows
80 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
81 Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
82 you need depends largely on what C/C++ libraries you want to interoperate with:
83 for interop with software produced by Visual Studio use the MSVC build of Rust;
84 for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
89 [MSYS2][msys2] can be used to easily build Rust on Windows:
91 [msys2]: https://msys2.github.io/
93 1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
95 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
96 MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit
97 Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
98 -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
100 3. From this terminal, install the required tools:
103 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
104 $ pacman -Sy pacman-mirrors
106 # Install build tools needed for Rust. If you're building a 32-bit compiler,
107 # then replace "x86_64" below with "i686". If you've already got git, python,
108 # or CMake installed and in PATH you can remove them from this list. Note
109 # that it is important that you do **not** use the 'python2' and 'cmake'
110 # packages from the 'msys2' subsystem. The build has historically been known
111 # to fail with these packages.
116 mingw-w64-x86_64-python2 \
117 mingw-w64-x86_64-cmake \
121 4. Navigate to Rust's source code (or clone it), then build it:
124 $ ./x.py build && ./x.py install
129 MSVC builds of Rust additionally require an installation of Visual Studio 2017
130 (or later) so `rustc` can use its linker. The simplest way is to get the
131 [Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
133 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
135 (If you're installing cmake yourself, be careful that “C++ CMake tools for
136 Windows” doesn't get included under “Individual components”.)
138 With these dependencies installed, you can build the compiler in a `cmd.exe`
145 Currently, building Rust only works with some known versions of Visual Studio. If
146 you have a more recent version installed the build system doesn't understand
147 then you may need to force rustbuild to use an older version. This can be done
148 by manually calling the appropriate vcvars file before running the bootstrap.
151 > CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
155 ### Building rustc with older host toolchains
156 It is still possible to build Rust with the older toolchain versions listed below, but only if the
157 LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN option is set to true in the config.toml file.
162 * Visual Studio 2015 (Update 3)
164 Toolchain versions older than what is listed above cannot be used to build rustc.
166 #### Specifying an ABI
168 Each specific ABI can also be used from either environment (for example, using
169 the GNU ABI in PowerShell) by using an explicit build triple. The available
170 Windows build triples are:
171 - GNU ABI (using GCC)
172 - `i686-pc-windows-gnu`
173 - `x86_64-pc-windows-gnu`
175 - `i686-pc-windows-msvc`
176 - `x86_64-pc-windows-msvc`
178 The build triple can be specified by either specifying `--build=<triple>` when
179 invoking `x.py` commands, or by copying the `config.toml` file (as described
180 in [Installing From Source](#installing-from-source)), and modifying the
181 `build` option under the `[build]` section.
183 ### Configure and Make
185 While it's not the recommended build system, this project also provides a
186 configure script and makefile (the latter of which just invokes `x.py`).
190 $ make && sudo make install
193 When using the configure script, the generated `config.mk` file may override the
194 `config.toml` file. To go back to the `config.toml` file, delete the generated
197 ## Building Documentation
199 If you’d like to build the documentation, it’s almost the same:
205 The generated documentation will appear under `doc` in the `build` directory for
206 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
207 `build\x86_64-pc-windows-msvc\doc`.
211 Since the Rust compiler is written in Rust, it must be built by a
212 precompiled "snapshot" version of itself (made in an earlier stage of
213 development). As such, source builds require a connection to the Internet, to
214 fetch snapshots, and an OS that can execute the available snapshot binaries.
216 Snapshot binaries are currently built and tested on several platforms:
218 | Platform / Architecture | x86 | x86_64 |
219 |----------------------------|-----|--------|
220 | Windows (7, 8, 10, ...) | ✓ | ✓ |
221 | Linux (2.6.18 or later) | ✓ | ✓ |
222 | macOS (10.7 Lion or later) | ✓ | ✓ |
224 You may find that other platforms work, but these are our officially
225 supported build environments that are most likely to work.
227 There is more advice about hacking on Rust in [CONTRIBUTING.md].
229 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
233 The Rust community congregates in a few places:
235 * [Stack Overflow] - Direct questions about using the language.
236 * [users.rust-lang.org] - General discussion and broader questions.
237 * [/r/rust] - News and general discussion.
239 [Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
240 [/r/rust]: https://reddit.com/r/rust
241 [users.rust-lang.org]: https://users.rust-lang.org/
245 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
247 Most real-time collaboration happens in a variety of channels on the
248 [Rust Discord server][rust-discord], with channels dedicated for getting help,
249 community, documentation, and all major contribution areas in the Rust ecosystem.
250 A good place to ask for help would be the #help channel.
252 The [rustc guide] might be a good place to start if you want to find out how
253 various parts of the compiler work.
255 Also, you may find the [rustdocs for the compiler itself][rustdocs] useful.
257 [rust-discord]: https://discord.gg/rust-lang
258 [rustc guide]: https://rust-lang.github.io/rustc-guide/about-this-guide.html
259 [rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
263 Rust is primarily distributed under the terms of both the MIT license
264 and the Apache License (Version 2.0), with portions covered by various
267 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
268 [COPYRIGHT](COPYRIGHT) for details.
272 The Rust programming language is an open source, community project governed
273 by a core team. It is also sponsored by the Mozilla Foundation (“Mozilla”),
274 which owns and protects the Rust and Cargo trademarks and logos
275 (the “Rust Trademarks”).
277 If you want to use these names or brands, please read the [media guide][media-guide].
279 Third-party logos may be subject to third-party copyrights and trademarks. See
280 [Licenses][policies-licenses] for details.
282 [media-guide]: https://www.rust-lang.org/policies/media-guide
283 [policies-licenses]: https://www.rust-lang.org/policies/licenses