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 2013
 134 (or later) so `rustc` can use its linker. Make sure to check the “C++ tools”
 135 option.
 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 the build system doesn't understand
 146 then 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 14.0\VC\bin\amd64\vcvars64.bat"
 151 > python x.py build
 152 ```
 153
 154 #### Specifying an ABI
 155 [specifying-an-abi]: #specifying-an-abi
 156
 157 Each specific ABI can also be used from either environment (for example, using
 158 the GNU ABI in PowerShell) by using an explicit build triple. The available
 159 Windows build triples are:
 160 - GNU ABI (using GCC)
 161     - `i686-pc-windows-gnu`
 162     - `x86_64-pc-windows-gnu`
 163 - The MSVC ABI
 164     - `i686-pc-windows-msvc`
 165     - `x86_64-pc-windows-msvc`
 166
 167 The build triple can be specified by either specifying `--build=<triple>` when
 168 invoking `x.py` commands, or by copying the `config.toml` file (as described
 169 in Building From Source), and modifying the `build` option under the `[build]`
 170 section.
 171
 172 ### Configure and Make
 173 [configure-and-make]: #configure-and-make
 174
 175 While it's not the recommended build system, this project also provides a
 176 configure script and makefile (the latter of which just invokes `x.py`).
 177
 178 ```sh
 179 $ ./configure
 180 $ make && sudo make install
 181 ```
 182
 183 When using the configure script, the generated `config.mk` file may override the
 184 `config.toml` file. To go back to the `config.toml` file, delete the generated
 185 `config.mk` file.
 186
 187 ## Building Documentation
 188 [building-documentation]: #building-documentation
 189
 190 If you’d like to build the documentation, it’s almost the same:
 191
 192 ```sh
 193 $ ./x.py doc
 194 ```
 195
 196 The generated documentation will appear under `doc` in the `build` directory for
 197 the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
 198 `build\x86_64-pc-windows-msvc\doc`.
 199
 200 ## Notes
 201 [notes]: #notes
 202
 203 Since the Rust compiler is written in Rust, it must be built by a
 204 precompiled "snapshot" version of itself (made in an earlier stage of
 205 development). As such, source builds require a connection to the Internet, to
 206 fetch snapshots, and an OS that can execute the available snapshot binaries.
 207
 208 Snapshot binaries are currently built and tested on several platforms:
 209
 210 | Platform / Architecture  | x86 | x86_64 |
 211 |--------------------------|-----|--------|
 212 | Windows (7, 8, 10, ...)  | ✓   | ✓      |
 213 | Linux (2.6.18 or later)  | ✓   | ✓      |
 214 | OSX (10.7 Lion or later) | ✓   | ✓      |
 215
 216 You may find that other platforms work, but these are our officially
 217 supported build environments that are most likely to work.
 218
 219 There is more advice about hacking on Rust in [CONTRIBUTING.md].
 220
 221 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
 222
 223 ## Getting Help
 224 [getting-help]: #getting-help
 225
 226 The Rust community congregates in a few places:
 227
 228 * [Stack Overflow] - Direct questions about using the language.
 229 * [users.rust-lang.org] - General discussion and broader questions.
 230 * [/r/rust] - News and general discussion.
 231
 232 [Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
 233 [/r/rust]: https://reddit.com/r/rust
 234 [users.rust-lang.org]: https://users.rust-lang.org/
 235
 236 ## Contributing
 237 [contributing]: #contributing
 238
 239 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
 240
 241 Rust has an [IRC] culture and most real-time collaboration happens in a
 242 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
 243 most popular channel is [#rust], a venue for general discussion about
 244 Rust. And a good place to ask for help would be [#rust-beginners].
 245
 246 The [rustc guide] might be a good place to start if you want to find out how
 247 various parts of the compiler work.
 248
 249 Also, you may find the [rustdocs for the compiler itself][rustdocs] useful.
 250
 251 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
 252 [#rust]: irc://irc.mozilla.org/rust
 253 [#rust-beginners]: irc://irc.mozilla.org/rust-beginners
 254 [rustc guide]: https://rust-lang.github.io/rustc-guide/about-this-guide.html
 255 [rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
 256
 257 ## License
 258 [license]: #license
 259
 260 Rust is primarily distributed under the terms of both the MIT license
 261 and the Apache License (Version 2.0), with portions covered by various
 262 BSD-like licenses.
 263
 264 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
 265 [COPYRIGHT](COPYRIGHT) for details.
 266
 267 ## Trademark
 268 [trademark]: #trademark
 269
 270 The Rust programming language is an open source, community project governed
 271 by a core team. It is also sponsored by the Mozilla Foundation (“Mozilla”),
 272 which owns and protects the Rust and Cargo trademarks and logos
 273 (the “Rust Trademarks”).
 274
 275 If you want to use these names or brands, please read the [media guide][media-guide].
 276
 277 Third-party logos may be subject to third-party copyrights and trademarks. See
 278 [Licenses][policies-licenses] for details.
 279
 280 [media-guide]: https://www.rust-lang.org/policies/media-guide
 281 [policies-licenses]: https://www.rust-lang.org/policies/licenses