README.md

   1 [![Build Status](https://dev.azure.com/rust-lang-azure/rust/_apis/build/status/johnterickson.rust?branchName=master)](https://dev.azure.com/rust-lang-azure/rust/_build/latest?definitionId=6&branchName=master)
   2
   3 # The Rust Programming Language
   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 ## Quick Start
  11 [quick-start]: #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 [building-from-source]: #building-from-source
  20
  21 _Note: If you wish to contribute to the compiler, you should read
  22 [this chapter](https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html)
  23 of the rustc-guide instead._
  24
  25 ### Building on *nix
  26 1. Make sure you have installed the dependencies:
  27
  28    * `g++` 4.7 or later or `clang++` 3.x or later
  29    * `python` 2.7 (but not 3.x)
  30    * GNU `make` 3.81 or later
  31    * `cmake` 3.4.3 or later
  32    * `curl`
  33    * `git`
  34
  35 2. Clone the [source] with `git`:
  36
  37    ```sh
  38    $ git clone https://github.com/rust-lang/rust.git
  39    $ cd rust
  40    ```
  41
  42 [source]: https://github.com/rust-lang/rust
  43
  44 3. Build and install:
  45
  46     ```sh
  47     $ ./x.py build && sudo ./x.py install
  48     ```
  49
  50     If after running `sudo ./x.py install` you see an error message like
  51
  52     ```
  53     error: failed to load source for a dependency on 'cc'
  54     ```
  55
  56     then run these two commands and then try `sudo ./x.py install` again:
  57
  58     ```
  59     $ cargo install cargo-vendor
  60     ```
  61
  62     ```
  63     $ cargo vendor
  64     ```
  65
  66     > ***Note:*** Install locations can be adjusted by copying the config file
  67     > from `./config.toml.example` to `./config.toml`, and
  68     > adjusting the `prefix` option under `[install]`. Various other options, such
  69     > as enabling debug information, are also supported, and are documented in
  70     > the config file.
  71
  72     When complete, `sudo ./x.py install` will place several programs into
  73     `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
  74     API-documentation tool. This install does not include [Cargo],
  75     Rust's package manager, which you may also want to build.
  76
  77 [Cargo]: https://github.com/rust-lang/cargo
  78
  79 ### Building on Windows
  80 [building-on-windows]: #building-on-windows
  81
  82 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
  83 Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
  84 you need depends largely on what C/C++ libraries you want to interoperate with:
  85 for interop with software produced by Visual Studio use the MSVC build of Rust;
  86 for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
  87 build.
  88
  89 #### MinGW
  90 [windows-mingw]: #windows-mingw
  91
  92 [MSYS2][msys2] can be used to easily build Rust on Windows:
  93
  94 [msys2]: https://msys2.github.io/
  95
  96 1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
  97
  98 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
  99    MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit
 100    Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
 101    -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
 102
 103 3. From this terminal, install the required tools:
 104
 105    ```sh
 106    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
 107    $ pacman -Sy pacman-mirrors
 108
 109    # Install build tools needed for Rust. If you're building a 32-bit compiler,
 110    # then replace "x86_64" below with "i686". If you've already got git, python,
 111    # or CMake installed and in PATH you can remove them from this list. Note
 112    # that it is important that you do **not** use the 'python2' and 'cmake'
 113    # packages from the 'msys2' subsystem. The build has historically been known
 114    # to fail with these packages.
 115    $ pacman -S git \
 116                make \
 117                diffutils \
 118                tar \
 119                mingw-w64-x86_64-python2 \
 120                mingw-w64-x86_64-cmake \
 121                mingw-w64-x86_64-gcc
 122    ```
 123
 124 4. Navigate to Rust's source code (or clone it), then build it:
 125
 126    ```sh
 127    $ ./x.py build && ./x.py install
 128    ```
 129
 130 #### MSVC
 131 [windows-msvc]: #windows-msvc
 132
 133 MSVC builds of Rust additionally require an installation of Visual Studio 2017
 134 (or later) so `rustc` can use its linker.  The simplest way is to get the
 135 [Visual Studio Build Tools] and check the “C++ build tools” workload.
 136
 137 [Visual Studio Build Tools]: https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019
 138
 139 At last check (cmake 3.14.3 and msvc 16.0.3) using the 2019 tools fails to
 140 build the in-tree LLVM build with a CMake error, so use 2017 instead by
 141 including the “MSVC v141 – VS 2017 C++ x64/x86 build tools (v14.16)” component.
 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 the build system doesn't understand
 152 then 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 14.0\VC\bin\amd64\vcvars64.bat"
 157 > python x.py build
 158 ```
 159
 160 #### Specifying an ABI
 161 [specifying-an-abi]: #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 Building From Source), and modifying the `build` option under the `[build]`
 176 section.
 177
 178 ### Configure and Make
 179 [configure-and-make]: #configure-and-make
 180
 181 While it's not the recommended build system, this project also provides a
 182 configure script and makefile (the latter of which just invokes `x.py`).
 183
 184 ```sh
 185 $ ./configure
 186 $ make && sudo make install
 187 ```
 188
 189 When using the configure script, the generated `config.mk` file may override the
 190 `config.toml` file. To go back to the `config.toml` file, delete the generated
 191 `config.mk` file.
 192
 193 ## Building Documentation
 194 [building-documentation]: #building-documentation
 195
 196 If you’d like to build the documentation, it’s almost the same:
 197
 198 ```sh
 199 $ ./x.py doc
 200 ```
 201
 202 The generated documentation will appear under `doc` in the `build` directory for
 203 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
 204 `build\x86_64-pc-windows-msvc\doc`.
 205
 206 ## Notes
 207 [notes]: #notes
 208
 209 Since the Rust compiler is written in Rust, it must be built by a
 210 precompiled "snapshot" version of itself (made in an earlier stage of
 211 development). As such, source builds require a connection to the Internet, to
 212 fetch snapshots, and an OS that can execute the available snapshot binaries.
 213
 214 Snapshot binaries are currently built and tested on several platforms:
 215
 216 | Platform / Architecture  | x86 | x86_64 |
 217 |--------------------------|-----|--------|
 218 | Windows (7, 8, 10, ...)  | ✓   | ✓      |
 219 | Linux (2.6.18 or later)  | ✓   | ✓      |
 220 | OSX (10.7 Lion or later) | ✓   | ✓      |
 221
 222 You may find that other platforms work, but these are our officially
 223 supported build environments that are most likely to work.
 224
 225 There is more advice about hacking on Rust in [CONTRIBUTING.md].
 226
 227 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
 228
 229 ## Getting Help
 230 [getting-help]: #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 [contributing]: #contributing
 244
 245 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
 246
 247 Rust has an [IRC] culture and most real-time collaboration happens in a
 248 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
 249 most popular channel is [#rust], a venue for general discussion about
 250 Rust. And a good place to ask for help would be [#rust-beginners].
 251
 252 The [rustc guide] might be a good place to start if you want to find out how
 253 various parts of the compiler work.
 254
 255 Also, you may find the [rustdocs for the compiler itself][rustdocs] useful.
 256
 257 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
 258 [#rust]: irc://irc.mozilla.org/rust
 259 [#rust-beginners]: irc://irc.mozilla.org/rust-beginners
 260 [rustc guide]: https://rust-lang.github.io/rustc-guide/about-this-guide.html
 261 [rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
 262
 263 ## License
 264 [license]: #license
 265
 266 Rust is primarily distributed under the terms of both the MIT license
 267 and the Apache License (Version 2.0), with portions covered by various
 268 BSD-like licenses.
 269
 270 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
 271 [COPYRIGHT](COPYRIGHT) for details.
 272
 273 ## Trademark
 274 [trademark]: #trademark
 275
 276 The Rust programming language is an open source, community project governed
 277 by a core team. It is also sponsored by the Mozilla Foundation (“Mozilla”),
 278 which owns and protects the Rust and Cargo trademarks and logos
 279 (the “Rust Trademarks”).
 280
 281 If you want to use these names or brands, please read the [media guide][media-guide].
 282
 283 Third-party logos may be subject to third-party copyrights and trademarks. See
 284 [Licenses][policies-licenses] for details.
 285
 286 [media-guide]: https://www.rust-lang.org/policies/media-guide
 287 [policies-licenses]: https://www.rust-lang.org/policies/licenses