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