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