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