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