README.md

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