README.md

   1 # The Rust Programming Language
   2
   3 This is the main source code repository for [Rust]. It contains the compiler,
   4 standard library, and documentation.
   5
   6 [Rust]: https://www.rust-lang.org
   7
   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.
  10
  11 ## Quick Start
  12
  13 Read ["Installation"] from [The Book].
  14
  15 ["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
  16 [The Book]: https://doc.rust-lang.org/book/index.html
  17
  18 ## Installing from Source
  19
  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.
  22
  23 The `x.py` command can be run directly on most systems in the following format:
  24
  25 ```sh
  26 ./x.py <subcommand> [flags]
  27 ```
  28
  29 This is how the documentation and examples assume you are running `x.py`.
  30
  31 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:
  32
  33 ```sh
  34 # Python 3
  35 python3 x.py <subcommand> [flags]
  36
  37 # Python 2.7
  38 python2.7 x.py <subcommand> [flags]
  39 ```
  40
  41 More information about `x.py` can be found
  42 by running it with the `--help` flag or reading the [rustc dev guide][rustcguidebuild].
  43
  44 [gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
  45 [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html
  46
  47 ### Dependencies
  48
  49 Make sure you have installed the dependencies:
  50
  51    * `python` 3 or 2.7
  52    * `git`
  53    * A C compiler (when building for the host, `cc` is enough; cross-compiling may need additional compilers)
  54    * `curl` (not needed on Windows)
  55    * `pkg-config` if you are compiling on Linux and targeting Linux
  56    * `libiconv` (already included with glibc on Debian-based distros)
  57
  58 To build cargo, you'll also need OpenSSL (`libssl-dev` or `openssl-devel` on most Unix distros).
  59
  60 If building LLVM from source, you'll need additional tools:
  61
  62 * `g++`, `clang++`, or MSVC with versions listed on
  63   [LLVM's documentation](https://llvm.org/docs/GettingStarted.html#host-c-toolchain-both-compiler-and-standard-library)
  64 * `ninja`, or GNU `make` 3.81 or later (ninja is recommended, especially on Windows)
  65 * `cmake` 3.13.4 or later
  66 * `libstdc++-static` may be required on some Linux distributions such as Fedora and Ubuntu
  67
  68 On tier 1 or tier 2 with host tools platforms, you can also choose to download LLVM by setting `llvm.download-ci-llvm = true`.
  69 Otherwise, you'll need LLVM installed and `llvm-config` in your path.
  70 See [the rustc-dev-guide for more info][sysllvm].
  71
  72 [sysllvm]: https://rustc-dev-guide.rust-lang.org/building/new-target.html#using-pre-built-llvm
  73
  74
  75 ### Building on a Unix-like system
  76
  77 1. Clone the [source] with `git`:
  78
  79    ```sh
  80    git clone https://github.com/rust-lang/rust.git
  81    cd rust
  82    ```
  83
  84 [source]: https://github.com/rust-lang/rust
  85
  86 2. Configure the build settings:
  87
  88     The Rust build system uses a file named `config.toml` in the root of the
  89     source tree to determine various configuration settings for the build.
  90     Set up the defaults intended for distros to get started. You can see a full list of options
  91     in `config.toml.example`.
  92
  93     ```sh
  94     printf 'profile = "user" \nchangelog-seen = 2 \n' > config.toml
  95     ```
  96
  97     If you plan to use `x.py install` to create an installation, it is recommended
  98     that you set the `prefix` value in the `[install]` section to a directory.
  99
 100 3. Build and install:
 101
 102     ```sh
 103     ./x.py build && ./x.py install
 104     ```
 105
 106     When complete, `./x.py install` will place several programs into
 107     `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
 108     API-documentation tool. If you've set `profile = "user"` or `build.extended = true`, it will
 109     also include [Cargo], Rust's package manager.
 110
 111 [Cargo]: https://github.com/rust-lang/cargo
 112
 113 ### Building on Windows
 114
 115 On Windows, we suggest using [winget] to install dependencies by running the following in a terminal:
 116
 117 ```powershell
 118 winget install -e Python.Python.3
 119 winget install -e Kitware.CMake
 120 winget install -e Git.Git
 121 ```
 122
 123 Then edit your system's `PATH` variable and add: `C:\Program Files\CMake\bin`. See
 124 [this guide on editing the system `PATH`](https://www.java.com/en/download/help/path.html) from the
 125 Java documentation.
 126
 127 [winget]: https://github.com/microsoft/winget-cli
 128
 129 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
 130 Visual Studio and the GNU ABI used by the GCC toolchain. Which version of Rust
 131 you need depends largely on what C/C++ libraries you want to interoperate with.
 132 Use the MSVC build of Rust to interop with software produced by Visual Studio and
 133 the GNU build to interop with GNU software built using the MinGW/MSYS2 toolchain.
 134
 135 #### MinGW
 136
 137 [MSYS2][msys2] can be used to easily build Rust on Windows:
 138
 139 [msys2]: https://www.msys2.org/
 140
 141 1. Download the latest [MSYS2 installer][msys2] and go through the installer.
 142
 143 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from the MSYS2 installation
 144    directory (e.g. `C:\msys64`), depending on whether you want 32-bit or 64-bit
 145    Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
 146    -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
 147
 148 3. From this terminal, install the required tools:
 149
 150    ```sh
 151    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
 152    pacman -Sy pacman-mirrors
 153
 154    # Install build tools needed for Rust. If you're building a 32-bit compiler,
 155    # then replace "x86_64" below with "i686". If you've already got git, python,
 156    # or CMake installed and in PATH you can remove them from this list. Note
 157    # that it is important that you do **not** use the 'python2', 'cmake' and 'ninja'
 158    # packages from the 'msys2' subsystem. The build has historically been known
 159    # to fail with these packages.
 160    pacman -S git \
 161                make \
 162                diffutils \
 163                tar \
 164                mingw-w64-x86_64-python \
 165                mingw-w64-x86_64-cmake \
 166                mingw-w64-x86_64-gcc \
 167                mingw-w64-x86_64-ninja
 168    ```
 169
 170 4. Navigate to Rust's source code (or clone it), then build it:
 171
 172    ```sh
 173    ./x.py build && ./x.py install
 174    ```
 175
 176 #### MSVC
 177
 178 MSVC builds of Rust additionally require an installation of Visual Studio 2017
 179 (or later) so `rustc` can use its linker.  The simplest way is to get
 180 [Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
 181
 182 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
 183
 184 (If you're installing cmake yourself, be careful that “C++ CMake tools for
 185 Windows” doesn't get included under “Individual components”.)
 186
 187 With these dependencies installed, you can build the compiler in a `cmd.exe`
 188 shell with:
 189
 190 ```sh
 191 python x.py build
 192 ```
 193
 194 Right now, building Rust only works with some known versions of Visual Studio. If
 195 you have a more recent version installed and the build system doesn't understand,
 196 you may need to force rustbuild to use an older version. This can be done
 197 by manually calling the appropriate vcvars file before running the bootstrap.
 198
 199 ```batch
 200 CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
 201 python x.py build
 202 ```
 203
 204 #### Specifying an ABI
 205
 206 Each specific ABI can also be used from either environment (for example, using
 207 the GNU ABI in PowerShell) by using an explicit build triple. The available
 208 Windows build triples are:
 209 - GNU ABI (using GCC)
 210     - `i686-pc-windows-gnu`
 211     - `x86_64-pc-windows-gnu`
 212 - The MSVC ABI
 213     - `i686-pc-windows-msvc`
 214     - `x86_64-pc-windows-msvc`
 215
 216 The build triple can be specified by either specifying `--build=<triple>` when
 217 invoking `x.py` commands, or by creating a `config.toml` file (as described
 218 in [Installing From Source](#installing-from-source)), and modifying the
 219 `build` option under the `[build]` section.
 220
 221 ### Configure and Make
 222
 223 While it's not the recommended build system, this project also provides a
 224 configure script and makefile (the latter of which just invokes `x.py`).
 225
 226 ```sh
 227 ./configure
 228 make && sudo make install
 229 ```
 230
 231 `configure` generates a `config.toml` which can also be used with normal `x.py` invocations.
 232
 233 ## Building Documentation
 234
 235 If you’d like to build the documentation, it’s almost the same:
 236
 237 ```sh
 238 ./x.py doc
 239 ```
 240
 241 The generated documentation will appear under `doc` in the `build` directory for
 242 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
 243 `build\x86_64-pc-windows-msvc\doc`.
 244
 245 ## Notes
 246
 247 Since the Rust compiler is written in Rust, it must be built by a
 248 precompiled "snapshot" version of itself (made in an earlier stage of
 249 development). As such, source builds require an Internet connection to
 250 fetch snapshots, and an OS that can execute the available snapshot binaries.
 251
 252 See https://doc.rust-lang.org/nightly/rustc/platform-support.html for a list of supported platforms.
 253 Only "host tools" platforms have a pre-compiled snapshot binary available; to compile for a platform
 254 without host tools you must cross-compile.
 255
 256 You may find that other platforms work, but these are our officially
 257 supported build environments that are most likely to work.
 258
 259 ## Getting Help
 260
 261 See https://www.rust-lang.org/community for a list of chat platforms and forums.
 262
 263 ## Contributing
 264
 265 See [CONTRIBUTING.md](CONTRIBUTING.md).
 266
 267 ## License
 268
 269 Rust is primarily distributed under the terms of both the MIT license
 270 and the Apache License (Version 2.0), with portions covered by various
 271 BSD-like licenses.
 272
 273 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
 274 [COPYRIGHT](COPYRIGHT) for details.
 275
 276 ## Trademark
 277
 278 [The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
 279 trademarks and logos (the “Rust Trademarks”).
 280
 281 If you want to use these names or brands, please read the [media guide][media-guide].
 282
 283 Third-party logos may be subject to third-party copyrights and trademarks. See
 284 [Licenses][policies-licenses] for details.
 285
 286 [rust-foundation]: https://foundation.rust-lang.org/
 287 [media-guide]: https://www.rust-lang.org/policies/media-guide
 288 [policies-licenses]: https://www.rust-lang.org/policies/licenses