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