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