README.md

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