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