README.md

   1 # The Rust Programming Language
   2
   3 This is the main source code repository for [Rust]. It contains the compiler, standard library,
   4 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/installing-rust.html
  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 `clang++` 3.x
  20    * `python` 2.7 or later (but not 3.x)
  21    * GNU `make` 3.81 or later
  22    * `curl`
  23    * `git`
  24
  25 2. Clone the [source] with `git`:
  26
  27    ```sh
  28    $ git clone https://github.com/rust-lang/rust.git
  29    $ cd rust
  30    ```
  31
  32 [source]: https://github.com/rust-lang/rust
  33
  34 3. Build and install:
  35
  36     ```sh
  37     $ ./configure
  38     $ make && make install
  39     ```
  40
  41     > ***Note:*** You may need to use `sudo make install` if you do not
  42     > normally have permission to modify the destination directory. The
  43     > install locations can be adjusted by passing a `--prefix` argument
  44     > to `configure`. Various other options are also supported – pass
  45     > `--help` for more information on them.
  46
  47     When complete, `make install` will place several programs into
  48     `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
  49     API-documentation tool. This install does not include [Cargo],
  50     Rust's package manager, which you may also want to build.
  51
  52 [Cargo]: https://github.com/rust-lang/cargo
  53
  54 ### Building on Windows
  55
  56 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
  57 Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
  58 you need depends largely on what C/C++ libraries you want to interoperate with:
  59 for interop with software produced by Visual Studio use the MSVC build of Rust;
  60 for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
  61 build.
  62
  63
  64 #### MinGW
  65
  66 [MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows:
  67
  68 1. Grab the latest MSYS2 installer and go through the installer.
  69
  70 2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
  71    tools.
  72
  73    ```sh
  74    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
  75    $ pacman -Sy pacman-mirrors
  76    ```
  77
  78 Download [MinGW from
  79 here](http://mingw-w64.org/doku.php/download/mingw-builds), and choose the
  80 `threads=win32,exceptions=dwarf/seh` flavor when installing. After installing,
  81 add its `bin` directory to your `PATH`. This is due to [#28260](https://github.com/rust-lang/rust/issues/28260), in the future,
  82 installing from pacman should be just fine.
  83
  84    ```
  85    # Make git available in MSYS2 (if not already available on path)
  86    $ pacman -S git
  87
  88    $ pacman -S base-devel
  89    ```
  90
  91 3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
  92    MSYS2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
  93
  94 4. Navigate to Rust's source code, configure and build it:
  95
  96    ```sh
  97    $ ./configure
  98    $ make && make install
  99    ```
 100
 101 #### MSVC
 102
 103 MSVC builds of Rust additionally require an installation of Visual Studio 2013
 104 (or later) so `rustc` can use its linker. Make sure to check the “C++ tools”
 105 option. In addition, `cmake` needs to be installed to build LLVM.
 106
 107 With these dependencies installed, the build takes two steps:
 108
 109 ```sh
 110 $ ./configure
 111 $ make && make install
 112 ```
 113
 114 ## Building Documentation
 115
 116 If you’d like to build the documentation, it’s almost the same:
 117
 118 ```sh
 119 ./configure
 120 $ make docs
 121 ```
 122
 123 Building the documentation requires building the compiler, so the above
 124 details will apply. Once you have the compiler built, you can
 125
 126 ```sh
 127 $ make docs NO_REBUILD=1
 128 ```
 129
 130 To make sure you don’t re-build the compiler because you made a change
 131 to some documentation.
 132
 133 The generated documentation will appear in a top-level `doc` directory,
 134 created by the `make` rule.
 135
 136 ## Notes
 137
 138 Since the Rust compiler is written in Rust, it must be built by a
 139 precompiled "snapshot" version of itself (made in an earlier state of
 140 development). As such, source builds require a connection to the Internet, to
 141 fetch snapshots, and an OS that can execute the available snapshot binaries.
 142
 143 Snapshot binaries are currently built and tested on several platforms:
 144
 145 | Platform \ Architecture        | x86 | x86_64 |
 146 |--------------------------------|-----|--------|
 147 | Windows (7, 8, Server 2008 R2) | ✓   | ✓      |
 148 | Linux (2.6.18 or later)        | ✓   | ✓      |
 149 | OSX (10.7 Lion or later)       | ✓   | ✓      |
 150
 151 You may find that other platforms work, but these are our officially
 152 supported build environments that are most likely to work.
 153
 154 Rust currently needs between 600MiB and 1.5GiB to build, depending on platform. If it hits
 155 swap, it will take a very long time to build.
 156
 157 There is more advice about hacking on Rust in [CONTRIBUTING.md].
 158
 159 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
 160
 161 ## Getting Help
 162
 163 The Rust community congregates in a few places:
 164
 165 * [Stack Overflow] - Direct questions about using the language.
 166 * [users.rust-lang.org] - General discussion and broader questions.
 167 * [/r/rust] - News and general discussion.
 168
 169 [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
 170 [/r/rust]: http://reddit.com/r/rust
 171 [users.rust-lang.org]: https://users.rust-lang.org/
 172
 173 ## Contributing
 174
 175 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
 176
 177 Rust has an [IRC] culture and most real-time collaboration happens in a
 178 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
 179 most popular channel is [#rust], a venue for general discussion about
 180 Rust, and a good place to ask for help.
 181
 182 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
 183 [#rust]: irc://irc.mozilla.org/rust
 184
 185 ## License
 186
 187 Rust is primarily distributed under the terms of both the MIT license
 188 and the Apache License (Version 2.0), with portions covered by various
 189 BSD-like licenses.
 190
 191 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.