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 ### Building on a Unix-like system
  48 1. Make sure you have installed the dependencies:
  49
  50    * `g++` 5.1 or later or `clang++` 3.5 or later
  51    * `python` 3 or 2.7
  52    * GNU `make` 3.81 or later
  53    * `cmake` 3.13.4 or later
  54    * `ninja`
  55    * `curl`
  56    * `git`
  57    * `ssl` which comes in `libssl-dev` or `openssl-devel`
  58    * `pkg-config` if you are compiling on Linux and targeting Linux
  59
  60 2. Clone the [source] with `git`:
  61
  62    ```sh
  63    git clone https://github.com/rust-lang/rust.git
  64    cd rust
  65    ```
  66
  67 [source]: https://github.com/rust-lang/rust
  68
  69 3. Configure the build settings:
  70
  71     The Rust build system uses a file named `config.toml` in the root of the
  72     source tree to determine various configuration settings for the build.
  73     Copy the default `config.toml.example` to `config.toml` to get started.
  74
  75     ```sh
  76     cp config.toml.example config.toml
  77     ```
  78
  79     If you plan to use `x.py install` to create an installation, it is recommended
  80     that you set the `prefix` value in the `[install]` section to a directory.
  81
  82     Create an install directory if you are not installing in the default directory.
  83
  84 4. Build and install:
  85
  86     ```sh
  87     ./x.py build && ./x.py install
  88     ```
  89
  90     When complete, `./x.py install` will place several programs into
  91     `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
  92     API-documentation tool. This install does not include [Cargo],
  93     Rust's package manager. To build and install Cargo, you may
  94     run `./x.py install cargo` or set the `build.extended` key in
  95     `config.toml` to `true` to build and install all tools.
  96
  97 [Cargo]: https://github.com/rust-lang/cargo
  98
  99 ### Building on Windows
 100
 101 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
 102 Visual Studio and the GNU ABI used by the GCC toolchain. Which version of Rust
 103 you need depends largely on what C/C++ libraries you want to interoperate with.
 104 Use the MSVC build of Rust to interop with software produced by Visual Studio and
 105 the GNU build to interop with GNU software built using the MinGW/MSYS2 toolchain.
 106
 107 #### MinGW
 108
 109 [MSYS2][msys2] can be used to easily build Rust on Windows:
 110
 111 [msys2]: https://www.msys2.org/
 112
 113 1. Download the latest [MSYS2 installer][msys2] and go through the installer.
 114
 115 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from the MSYS2 installation
 116    directory (e.g. `C:\msys64`), depending on whether you want 32-bit or 64-bit
 117    Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
 118    -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
 119
 120 3. From this terminal, install the required tools:
 121
 122    ```sh
 123    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
 124    pacman -Sy pacman-mirrors
 125
 126    # Install build tools needed for Rust. If you're building a 32-bit compiler,
 127    # then replace "x86_64" below with "i686". If you've already got git, python,
 128    # or CMake installed and in PATH you can remove them from this list. Note
 129    # that it is important that you do **not** use the 'python2', 'cmake' and 'ninja'
 130    # packages from the 'msys2' subsystem. The build has historically been known
 131    # to fail with these packages.
 132    pacman -S git \
 133                make \
 134                diffutils \
 135                tar \
 136                mingw-w64-x86_64-python \
 137                mingw-w64-x86_64-cmake \
 138                mingw-w64-x86_64-gcc \
 139                mingw-w64-x86_64-ninja
 140    ```
 141
 142 4. Navigate to Rust's source code (or clone it), then build it:
 143
 144    ```sh
 145    ./x.py build && ./x.py install
 146    ```
 147
 148 #### MSVC
 149
 150 MSVC builds of Rust additionally require an installation of Visual Studio 2017
 151 (or later) so `rustc` can use its linker.  The simplest way is to get
 152 [Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
 153
 154 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
 155
 156 (If you're installing cmake yourself, be careful that “C++ CMake tools for
 157 Windows” doesn't get included under “Individual components”.)
 158
 159 With these dependencies installed, you can build the compiler in a `cmd.exe`
 160 shell with:
 161
 162 ```sh
 163 python x.py build
 164 ```
 165
 166 Right now, building Rust only works with some known versions of Visual Studio. If
 167 you have a more recent version installed and the build system doesn't understand,
 168 you may need to force rustbuild to use an older version. This can be done
 169 by manually calling the appropriate vcvars file before running the bootstrap.
 170
 171 ```batch
 172 CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
 173 python x.py build
 174 ```
 175
 176 #### Specifying an ABI
 177
 178 Each specific ABI can also be used from either environment (for example, using
 179 the GNU ABI in PowerShell) by using an explicit build triple. The available
 180 Windows build triples are:
 181 - GNU ABI (using GCC)
 182     - `i686-pc-windows-gnu`
 183     - `x86_64-pc-windows-gnu`
 184 - The MSVC ABI
 185     - `i686-pc-windows-msvc`
 186     - `x86_64-pc-windows-msvc`
 187
 188 The build triple can be specified by either specifying `--build=<triple>` when
 189 invoking `x.py` commands, or by copying the `config.toml` file (as described
 190 in [Installing From Source](#installing-from-source)), and modifying the
 191 `build` option under the `[build]` section.
 192
 193 ### Configure and Make
 194
 195 While it's not the recommended build system, this project also provides a
 196 configure script and makefile (the latter of which just invokes `x.py`).
 197
 198 ```sh
 199 ./configure
 200 make && sudo make install
 201 ```
 202
 203 When using the configure script, the generated `config.mk` file may override the
 204 `config.toml` file. To go back to the `config.toml` file, delete the generated
 205 `config.mk` file.
 206
 207 ## Building Documentation
 208
 209 If you’d like to build the documentation, it’s almost the same:
 210
 211 ```sh
 212 ./x.py doc
 213 ```
 214
 215 The generated documentation will appear under `doc` in the `build` directory for
 216 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
 217 `build\x86_64-pc-windows-msvc\doc`.
 218
 219 ## Notes
 220
 221 Since the Rust compiler is written in Rust, it must be built by a
 222 precompiled "snapshot" version of itself (made in an earlier stage of
 223 development). As such, source builds require an Internet connection to
 224 fetch snapshots, and an OS that can execute the available snapshot binaries.
 225
 226 See https://doc.rust-lang.org/nightly/rustc/platform-support.html for a list of supported platforms.
 227 Only "host tools" platforms have a pre-compiled snapshot binary available; to compile for a platform
 228 without host tools you must cross-compile.
 229
 230 You may find that other platforms work, but these are our officially
 231 supported build environments that are most likely to work.
 232
 233 ## Getting Help
 234
 235 See https://www.rust-lang.org/community for a list of chat platforms and forums.
 236
 237 ## Contributing
 238
 239 See [CONTRIBUTING.md](CONTRIBUTING.md).
 240
 241 ## License
 242
 243 Rust is primarily distributed under the terms of both the MIT license
 244 and the Apache License (Version 2.0), with portions covered by various
 245 BSD-like licenses.
 246
 247 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
 248 [COPYRIGHT](COPYRIGHT) for details.
 249
 250 ## Trademark
 251
 252 [The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
 253 trademarks and logos (the “Rust Trademarks”).
 254
 255 If you want to use these names or brands, please read the [media guide][media-guide].
 256
 257 Third-party logos may be subject to third-party copyrights and trademarks. See
 258 [Licenses][policies-licenses] for details.
 259
 260 [rust-foundation]: https://foundation.rust-lang.org/
 261 [media-guide]: https://www.rust-lang.org/policies/media-guide
 262 [policies-licenses]: https://www.rust-lang.org/policies/licenses