README.md

   1 <a href = "https://www.rust-lang.org/">
   2 <img width = "90%" height = "auto" src = "https://img.shields.io/badge/Rust-Programming%20Language-black?style=flat&logo=rust" alt = "The Rust Programming Language">
   3 </a>
   4
   5 This is the main source code repository for [Rust]. It contains the compiler,
   6 standard library, and documentation.
   7
   8 [Rust]: https://www.rust-lang.org
   9
  10 **Note: this README is for _users_ rather than _contributors_.**
  11
  12 ## Quick Start
  13
  14 Read ["Installation"] from [The Book].
  15
  16 ["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
  17 [The Book]: https://doc.rust-lang.org/book/index.html
  18
  19 ## Installing from Source
  20
  21 **Note: If you wish to _contribute_ to the compiler, you should read the
  22 [Getting Started][gettingstarted] of the rustc-dev-guide instead of this
  23 section.**
  24
  25 The Rust build system uses a Python script called `x.py` to build the compiler,
  26 which manages the bootstrapping process. More information about it can be found
  27 by running `./x.py --help` or reading the [rustc dev guide][rustcguidebuild].
  28
  29 [gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
  30 [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html
  31
  32 ### Building on a Unix-like system
  33 1. Make sure you have installed the dependencies:
  34
  35    * `g++` 5.1 or later or `clang++` 3.5 or later
  36    * `python` 3 or 2.7
  37    * GNU `make` 3.81 or later
  38    * `cmake` 3.4.3 or later
  39    * `curl`
  40    * `git`
  41    * `ssl` which comes in `libssl-dev` or `openssl-devel`
  42    * `pkg-config` if you are compiling on Linux and targeting Linux
  43
  44 2. Clone the [source] with `git`:
  45
  46    ```sh
  47    $ git clone https://github.com/rust-lang/rust.git
  48    $ cd rust
  49    ```
  50
  51 [source]: https://github.com/rust-lang/rust
  52
  53 3. Configure the build settings:
  54
  55     The Rust build system uses a file named `config.toml` in the root of the
  56     source tree to determine various configuration settings for the build.
  57     Copy the default `config.toml.example` to `config.toml` to get started.
  58
  59     ```sh
  60     $ cp config.toml.example config.toml
  61     ```
  62
  63     If you plan to use `x.py install` to create an installation, it is recommended
  64     that you set the `prefix` value in the `[install]` section to a directory.
  65
  66     Create install directory if you are not installing in default directory
  67
  68 4. Build and install:
  69
  70     ```sh
  71     $ ./x.py build && ./x.py install
  72     ```
  73
  74     When complete, `./x.py install` will place several programs into
  75     `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
  76     API-documentation tool. This install does not include [Cargo],
  77     Rust's package manager. To build and install Cargo, you may
  78     run `./x.py install cargo` or set the `build.extended` key in
  79     `config.toml` to `true` to build and install all tools.
  80
  81 [Cargo]: https://github.com/rust-lang/cargo
  82
  83 ### Building on Windows
  84
  85 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
  86 Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
  87 you need depends largely on what C/C++ libraries you want to interoperate with:
  88 for interop with software produced by Visual Studio use the MSVC build of Rust;
  89 for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
  90 build.
  91
  92 #### MinGW
  93
  94 [MSYS2][msys2] can be used to easily build Rust on Windows:
  95
  96 [msys2]: https://msys2.github.io/
  97
  98 1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
  99
 100 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
 101    MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit
 102    Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
 103    -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
 104
 105 3. From this terminal, install the required tools:
 106
 107    ```sh
 108    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
 109    $ pacman -Sy pacman-mirrors
 110
 111    # Install build tools needed for Rust. If you're building a 32-bit compiler,
 112    # then replace "x86_64" below with "i686". If you've already got git, python,
 113    # or CMake installed and in PATH you can remove them from this list. Note
 114    # that it is important that you do **not** use the 'python2' and 'cmake'
 115    # packages from the 'msys2' subsystem. The build has historically been known
 116    # to fail with these packages.
 117    $ pacman -S git \
 118                make \
 119                diffutils \
 120                tar \
 121                mingw-w64-x86_64-python \
 122                mingw-w64-x86_64-cmake \
 123                mingw-w64-x86_64-gcc
 124    ```
 125
 126 4. Navigate to Rust's source code (or clone it), then build it:
 127
 128    ```sh
 129    $ ./x.py build && ./x.py install
 130    ```
 131
 132 #### MSVC
 133
 134 MSVC builds of Rust additionally require an installation of Visual Studio 2017
 135 (or later) so `rustc` can use its linker.  The simplest way is to get the
 136 [Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
 137
 138 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
 139
 140 (If you're installing cmake yourself, be careful that “C++ CMake tools for
 141 Windows” doesn't get included under “Individual components”.)
 142
 143 With these dependencies installed, you can build the compiler in a `cmd.exe`
 144 shell with:
 145
 146 ```sh
 147 > python x.py build
 148 ```
 149
 150 Currently, building Rust only works with some known versions of Visual Studio. If
 151 you have a more recent version installed and the build system doesn't understand,
 152 you may need to force rustbuild to use an older version. This can be done
 153 by manually calling the appropriate vcvars file before running the bootstrap.
 154
 155 ```batch
 156 > CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
 157 > python x.py build
 158 ```
 159
 160 ### Building rustc with older host toolchains
 161 It is still possible to build Rust with the older toolchain versions listed below, but only if the
 162 LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN option is set to true in the config.toml file.
 163
 164 * Clang 3.1
 165 * Apple Clang 3.1
 166 * GCC 4.8
 167 * Visual Studio 2015 (Update 3)
 168
 169 Toolchain versions older than what is listed above cannot be used to build rustc.
 170
 171 #### Specifying an ABI
 172
 173 Each specific ABI can also be used from either environment (for example, using
 174 the GNU ABI in PowerShell) by using an explicit build triple. The available
 175 Windows build triples are:
 176 - GNU ABI (using GCC)
 177     - `i686-pc-windows-gnu`
 178     - `x86_64-pc-windows-gnu`
 179 - The MSVC ABI
 180     - `i686-pc-windows-msvc`
 181     - `x86_64-pc-windows-msvc`
 182
 183 The build triple can be specified by either specifying `--build=<triple>` when
 184 invoking `x.py` commands, or by copying the `config.toml` file (as described
 185 in [Installing From Source](#installing-from-source)), and modifying the
 186 `build` option under the `[build]` section.
 187
 188 ### Configure and Make
 189
 190 While it's not the recommended build system, this project also provides a
 191 configure script and makefile (the latter of which just invokes `x.py`).
 192
 193 ```sh
 194 $ ./configure
 195 $ make && sudo make install
 196 ```
 197
 198 When using the configure script, the generated `config.mk` file may override the
 199 `config.toml` file. To go back to the `config.toml` file, delete the generated
 200 `config.mk` file.
 201
 202 ## Building Documentation
 203
 204 If you’d like to build the documentation, it’s almost the same:
 205
 206 ```sh
 207 $ ./x.py doc
 208 ```
 209
 210 The generated documentation will appear under `doc` in the `build` directory for
 211 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
 212 `build\x86_64-pc-windows-msvc\doc`.
 213
 214 ## Notes
 215
 216 Since the Rust compiler is written in Rust, it must be built by a
 217 precompiled "snapshot" version of itself (made in an earlier stage of
 218 development). As such, source builds require a connection to the Internet, to
 219 fetch snapshots, and an OS that can execute the available snapshot binaries.
 220
 221 Snapshot binaries are currently built and tested on several platforms:
 222
 223 | Platform / Architecture    | x86 | x86_64 |
 224 |----------------------------|-----|--------|
 225 | Windows (7, 8, 10, ...)    | ✓   | ✓      |
 226 | Linux (2.6.18 or later)    | ✓   | ✓      |
 227 | macOS (10.7 Lion or later) | ✓   | ✓      |
 228
 229 You may find that other platforms work, but these are our officially
 230 supported build environments that are most likely to work.
 231
 232 ## Getting Help
 233
 234 The Rust community congregates in a few places:
 235
 236 * [Stack Overflow] - Direct questions about using the language.
 237 * [users.rust-lang.org] - General discussion and broader questions.
 238 * [/r/rust] - News and general discussion.
 239
 240 [Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
 241 [/r/rust]: https://reddit.com/r/rust
 242 [users.rust-lang.org]: https://users.rust-lang.org/
 243
 244 ## Contributing
 245
 246 If you are interested in contributing to the Rust project, please take a look
 247 at the [Getting Started][gettingstarted] guide in the [rustc-dev-guide].
 248
 249 ## License
 250
 251 Rust is primarily distributed under the terms of both the MIT license
 252 and the Apache License (Version 2.0), with portions covered by various
 253 BSD-like licenses.
 254
 255 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
 256 [COPYRIGHT](COPYRIGHT) for details.
 257
 258 ## Trademark
 259
 260 The Rust programming language is an open source, community project governed
 261 by a core team. It is also sponsored by the Mozilla Foundation (“Mozilla”),
 262 which owns and protects the Rust and Cargo trademarks and logos
 263 (the “Rust Trademarks”).
 264
 265 If you want to use these names or brands, please read the [media guide][media-guide].
 266
 267 Third-party logos may be subject to third-party copyrights and trademarks. See
 268 [Licenses][policies-licenses] for details.
 269
 270 [media-guide]: https://www.rust-lang.org/policies/media-guide
 271 [policies-licenses]: https://www.rust-lang.org/policies/licenses