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    # *** see the note below ***
  73    $ pacman -S mingw-w64-i686-toolchain
  74    $ pacman -S mingw-w64-x86_64-toolchain
  75
  76    # Make git available in MSYS2 (if not already available on path)
  77    $ pacman -S git
  78
  79    $ pacman -S base-devel
  80    ```
  81
  82 3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
  83    MSYS2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
  84
  85 4. Navigate to Rust's source code, configure and build it:
  86
  87    ```sh
  88    $ ./configure
  89    $ make && make install
  90    ```
  91 > ***Note:*** gcc versions >= 5 currently have issues building LLVM on Windows
  92 > resulting in a segmentation fault when building Rust. In order to avoid this
  93 > it may be necessary to obtain an earlier version of gcc such as 4.9.x.
  94 > Msys's `pacman` will install the latest version, so for the time being it is
  95 > recommended to skip gcc toolchain installation step above and use [Mingw-Builds]
  96 > project's installer instead.  Be sure to add gcc `bin` directory to the path
  97 > before running `configure`.
  98 > For more information on this see issue #28260.
  99
 100 [Mingw-Builds]: http://sourceforge.net/projects/mingw-w64/
 101
 102 ## Building Documentation
 103
 104 If you’d like to build the documentation, it’s almost the same:
 105
 106 ```sh
 107 ./configure
 108 $ make docs
 109 ```
 110
 111 Building the documentation requires building the compiler, so the above
 112 details will apply. Once you have the compiler built, you can
 113
 114 ```sh
 115 $ make docs NO_REBUILD=1
 116 ```
 117
 118 To make sure you don’t re-build the compiler because you made a change
 119 to some documentation.
 120
 121 The generated documentation will appear in a top-level `doc` directory,
 122 created by the `make` rule.
 123
 124 ## Notes
 125
 126 Since the Rust compiler is written in Rust, it must be built by a
 127 precompiled "snapshot" version of itself (made in an earlier state of
 128 development). As such, source builds require a connection to the Internet, to
 129 fetch snapshots, and an OS that can execute the available snapshot binaries.
 130
 131 Snapshot binaries are currently built and tested on several platforms:
 132
 133 | Platform \ Architecture        | x86 | x86_64 |
 134 |--------------------------------|-----|--------|
 135 | Windows (7, 8, Server 2008 R2) | ✓   | ✓      |
 136 | Linux (2.6.18 or later)        | ✓   | ✓      |
 137 | OSX (10.7 Lion or later)       | ✓   | ✓      |
 138
 139 You may find that other platforms work, but these are our officially
 140 supported build environments that are most likely to work.
 141
 142 Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
 143 swap, it will take a very long time to build.
 144
 145 There is more advice about hacking on Rust in [CONTRIBUTING.md].
 146
 147 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
 148
 149 ## Getting Help
 150
 151 The Rust community congregates in a few places:
 152
 153 * [Stack Overflow] - Direct questions about using the language.
 154 * [users.rust-lang.org] - General discussion and broader questions.
 155 * [/r/rust] - News and general discussion.
 156
 157 [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
 158 [/r/rust]: http://reddit.com/r/rust
 159 [users.rust-lang.org]: https://users.rust-lang.org/
 160
 161 ## Contributing
 162
 163 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
 164
 165 Rust has an [IRC] culture and most real-time collaboration happens in a
 166 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
 167 most popular channel is [#rust], a venue for general discussion about
 168 Rust, and a good place to ask for help.
 169
 170 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
 171 [#rust]: irc://irc.mozilla.org/rust
 172
 173 ## License
 174
 175 Rust is primarily distributed under the terms of both the MIT license
 176 and the Apache License (Version 2.0), with portions covered by various
 177 BSD-like licenses.
 178
 179 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.