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