README.md

   1 # The Rust Programming Language
   2
   3 Rust is a fast systems programming language that guarantees
   4 memory safety and offers painless concurrency ([no data races]).
   5 It does not employ a garbage collector and has minimal runtime overhead.
   6
   7 This repo contains the code for the compiler (`rustc`), as well
   8 as standard libraries, tools and documentation for Rust.
   9
  10 [no data races]: http://blog.rust-lang.org/2015/04/10/Fearless-Concurrency.html
  11
  12 ## Quick Start
  13
  14 Read ["Installing Rust"] from [The Book].
  15
  16 ["Installing Rust"]: https://doc.rust-lang.org/book/installing-rust.html
  17 [The Book]: https://doc.rust-lang.org/book/index.html
  18
  19 ## Building from Source
  20
  21 1. Make sure you have installed the dependencies:
  22
  23    * `g++` 4.7 or `clang++` 3.x
  24    * `python` 2.6 or later (but not 3.x)
  25    * GNU `make` 3.81 or later
  26    * `curl`
  27    * `git`
  28
  29 2. Clone the [source] with `git`:
  30
  31    ```sh
  32    $ git clone https://github.com/rust-lang/rust.git
  33    $ cd rust
  34    ```
  35
  36 [source]: https://github.com/rust-lang/rust
  37
  38 3. Build and install:
  39
  40     ```sh
  41     $ ./configure
  42     $ make && make install
  43     ```
  44
  45     > ***Note:*** You may need to use `sudo make install` if you do not
  46     > normally have permission to modify the destination directory. The
  47     > install locations can be adjusted by passing a `--prefix` argument
  48     > to `configure`. Various other options are also supported – pass
  49     > `--help` for more information on them.
  50
  51     When complete, `make install` will place several programs into
  52     `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
  53     API-documentation tool. This install does not include [Cargo],
  54     Rust's package manager, which you may also want to build.
  55
  56 [Cargo]: https://github.com/rust-lang/cargo
  57
  58 ### Building on Windows
  59
  60 [MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows:
  61
  62 1. Grab the latest MSYS2 installer and go through the installer.
  63
  64 2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
  65    tools.
  66
  67    ```sh
  68    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
  69    $ pacman -Sy pacman-mirrors
  70
  71    # Choose one based on platform:
  72    $ pacman -S mingw-w64-i686-toolchain
  73    $ pacman -S mingw-w64-x86_64-toolchain
  74
  75    $ pacman -S base-devel
  76    ```
  77
  78 3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
  79    MSYS2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
  80
  81 4. Navigate to Rust's source code, configure and build it:
  82
  83    ```sh
  84    $ ./configure
  85    $ make && make install
  86    ```
  87 > ***Note:*** gcc versions >= 5 currently have issues building LLVM on Windows
  88 > resulting in a segmentation fault when building Rust. In order to avoid this
  89 > it may be necessary to obtain an earlier version of gcc such as 4.9.x.
  90 > Installers for earlier Windows builds of gcc are available at the
  91 > [Mingw-Builds] project.
  92
  93 [Mingw-Builds]: http://sourceforge.net/projects/mingw-w64/
  94
  95 ## Building Documentation
  96
  97 If you’d like to build the documentation, it’s almost the same:
  98
  99 ```sh
 100 ./configure
 101 $ make docs
 102 ```
 103
 104 Building the documentation requires building the compiler, so the above
 105 details will apply. Once you have the compiler built, you can
 106
 107 ```sh
 108 $ make docs NO_REBUILD=1
 109 ```
 110
 111 To make sure you don’t re-build the compiler because you made a change
 112 to some documentation.
 113
 114 The generated documentation will appear in a top-level `doc` directory,
 115 created by the `make` rule.
 116
 117 ## Notes
 118
 119 Since the Rust compiler is written in Rust, it must be built by a
 120 precompiled "snapshot" version of itself (made in an earlier state of
 121 development). As such, source builds require a connection to the Internet, to
 122 fetch snapshots, and an OS that can execute the available snapshot binaries.
 123
 124 Snapshot binaries are currently built and tested on several platforms:
 125
 126 | Platform \ Architecture        | x86 | x86_64 |
 127 |--------------------------------|-----|--------|
 128 | Windows (7, 8, Server 2008 R2) | ✓   | ✓      |
 129 | Linux (2.6.18 or later)        | ✓   | ✓      |
 130 | OSX (10.7 Lion or later)       | ✓   | ✓      |
 131
 132 You may find that other platforms work, but these are our officially
 133 supported build environments that are most likely to work.
 134
 135 Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
 136 swap, it will take a very long time to build.
 137
 138 There is more advice about hacking on Rust in [CONTRIBUTING.md].
 139
 140 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
 141
 142 ## Getting Help
 143
 144 The Rust community congregates in a few places:
 145
 146 * [Stack Overflow] - Direct questions about using the language.
 147 * [users.rust-lang.org] - General discussion and broader questions.
 148 * [/r/rust] - News and general discussion.
 149
 150 [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
 151 [/r/rust]: http://reddit.com/r/rust
 152 [users.rust-lang.org]: https://users.rust-lang.org/
 153
 154 ## Contributing
 155
 156 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
 157
 158 Rust has an [IRC] culture and most real-time collaboration happens in a
 159 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
 160 most popular channel is [#rust], a venue for general discussion about
 161 Rust, and a good place to ask for help.
 162
 163 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
 164 [#rust]: irc://irc.mozilla.org/rust
 165
 166 ## License
 167
 168 Rust is primarily distributed under the terms of both the MIT license
 169 and the Apache License (Version 2.0), with portions covered by various
 170 BSD-like licenses.
 171
 172 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.