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
  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     $ ./configure
  39     $ make && sudo make install
  40     ```
  41
  42     > ***Note:*** Install locations can be adjusted by passing a `--prefix`
  43     > argument to `configure`. Various other options are also supported – pass
  44     > `--help` for more information on them.
  45
  46     When complete, `sudo make 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
  63 #### MinGW
  64
  65 [MSYS2][msys2] can be used to easily build Rust on Windows:
  66
  67 [msys2]: https://msys2.github.io/
  68
  69 1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
  70
  71 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
  72    MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit
  73    Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
  74    -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
  75
  76 3. From this terminal, install the required tools:
  77
  78    ```sh
  79    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
  80    $ pacman -Sy pacman-mirrors
  81
  82    # Install build tools needed for Rust. If you're building a 32-bit compiler,
  83    # then replace "x86_64" below with "i686". If you've already got git, python,
  84    # or CMake installed and in PATH you can remove them from this list. Note
  85    # that it is important that you do **not** use the 'python2' and 'cmake'
  86    # packages from the 'msys2' subsystem. The build has historically been known
  87    # to fail with these packages.
  88    $ pacman -S git \
  89                make \
  90                diffutils \
  91                tar \
  92                mingw-w64-x86_64-python2 \
  93                mingw-w64-x86_64-cmake \
  94                mingw-w64-x86_64-gcc
  95    ```
  96
  97 4. Navigate to Rust's source code (or clone it), then configure and build it:
  98
  99    ```sh
 100    $ ./configure
 101    $ make && make install
 102    ```
 103
 104 #### MSVC
 105
 106 MSVC builds of Rust additionally require an installation of Visual Studio 2013
 107 (or later) so `rustc` can use its linker. Make sure to check the “C++ tools”
 108 option.
 109
 110 With these dependencies installed, you can build the compiler in a `cmd.exe`
 111 shell with:
 112
 113 ```sh
 114 > python x.py build
 115 ```
 116
 117 If you're running inside of an msys shell, however, you can run:
 118
 119 ```sh
 120 $ ./configure --build=x86_64-pc-windows-msvc
 121 $ make && make install
 122 ```
 123
 124 Currently building Rust only works with some known versions of Visual Studio. If
 125 you have a more recent version installed the build system doesn't understand
 126 then you may need to force rustbuild to use an older version. This can be done
 127 by manually calling the appropriate vcvars file before running the bootstrap.
 128
 129 ```
 130 CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat"
 131 python x.py build
 132 ```
 133
 134 ## Building Documentation
 135
 136 If you’d like to build the documentation, it’s almost the same:
 137
 138 ```sh
 139 $ ./configure
 140 $ make docs
 141 ```
 142
 143 The generated documentation will appear in a top-level `doc` directory,
 144 created by the `make` rule.
 145
 146 ## Notes
 147
 148 Since the Rust compiler is written in Rust, it must be built by a
 149 precompiled "snapshot" version of itself (made in an earlier state of
 150 development). As such, source builds require a connection to the Internet, to
 151 fetch snapshots, and an OS that can execute the available snapshot binaries.
 152
 153 Snapshot binaries are currently built and tested on several platforms:
 154
 155 | Platform / Architecture        | x86 | x86_64 |
 156 |--------------------------------|-----|--------|
 157 | Windows (7, 8, Server 2008 R2) | ✓   | ✓      |
 158 | Linux (2.6.18 or later)        | ✓   | ✓      |
 159 | OSX (10.7 Lion or later)       | ✓   | ✓      |
 160
 161 You may find that other platforms work, but these are our officially
 162 supported build environments that are most likely to work.
 163
 164 Rust currently needs between 600MiB and 1.5GiB to build, depending on platform.
 165 If it hits swap, it will take a very long time to build.
 166
 167 There is more advice about hacking on Rust in [CONTRIBUTING.md].
 168
 169 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
 170
 171 ## Getting Help
 172
 173 The Rust community congregates in a few places:
 174
 175 * [Stack Overflow] - Direct questions about using the language.
 176 * [users.rust-lang.org] - General discussion and broader questions.
 177 * [/r/rust] - News and general discussion.
 178
 179 [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
 180 [/r/rust]: http://reddit.com/r/rust
 181 [users.rust-lang.org]: https://users.rust-lang.org/
 182
 183 ## Contributing
 184
 185 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
 186
 187 Rust has an [IRC] culture and most real-time collaboration happens in a
 188 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
 189 most popular channel is [#rust], a venue for general discussion about
 190 Rust. And a good place to ask for help would be [#rust-beginners].
 191
 192 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
 193 [#rust]: irc://irc.mozilla.org/rust
 194 [#rust-beginners]: irc://irc.mozilla.org/rust-beginners
 195
 196 ## License
 197
 198 Rust is primarily distributed under the terms of both the MIT license
 199 and the Apache License (Version 2.0), with portions covered by various
 200 BSD-like licenses.
 201
 202 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
 203 [COPYRIGHT](COPYRIGHT) for details.