README.md

   1 # The Rust Programming Language
   2
   3 This is a compiler for Rust, including standard libraries, tools and
   4 documentation. Rust is a systems programming language that is fast,
   5 memory safe and multithreaded, but does not employ a garbage collector
   6 or otherwise impose significant runtime overhead.
   7
   8 ## Quick Start
   9
  10 Read ["Installing Rust"] from [The Book].
  11
  12 ["Installing Rust"]: http://doc.rust-lang.org/book/installing-rust.html
  13 [The Book]: http://doc.rust-lang.org/book/index.html
  14
  15 ## Building from Source
  16
  17 1. Make sure you have installed the dependencies:
  18     * `g++` 4.7 or `clang++` 3.x
  19     * `python` 2.6 or later (but not 3.x)
  20     * GNU `make` 3.81 or later
  21     * `curl`
  22     * `git`
  23
  24 2. Clone the [source] with `git`:
  25
  26         $ git clone https://github.com/rust-lang/rust.git
  27         $ cd rust
  28
  29 [source]: https://github.com/rust-lang/rust
  30
  31 3. Build and install:
  32
  33         $ ./configure
  34         $ make && make install
  35
  36     > ***Note:*** You may need to use `sudo make install` if you do not normally have
  37     > permission to modify the destination directory. The install locations can
  38     > be adjusted by passing a `--prefix` argument to `configure`. Various other
  39     > options are also supported, pass `--help` for more information on them.
  40
  41     When complete, `make install` will place several programs into
  42     `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
  43     API-documentation tool. This install does not include [Cargo],
  44     Rust's package manager, which you may also want to build.
  45
  46 [Cargo]: https://github.com/rust-lang/cargo
  47
  48 ### Building on Windows
  49
  50 To easily build on windows we can use [MSYS2](http://msys2.github.io/):
  51
  52 1. Grab the latest MSYS2 installer and go through the installer.
  53 2. Now from the MSYS2 terminal we want to install the mingw64 toolchain and the other
  54    tools we need.
  55
  56 ```bash
  57 # choose one based on platform
  58 $ pacman -S mingw-w64-i686-toolchain
  59 $ pacman -S mingw-w64-x86_64-toolchain
  60
  61 $ pacman -S base-devel
  62 ```
  63
  64 3. With that now start `mingw32_shell.bat` or `mingw64_shell.bat`
  65    from where you installed MSYS2 (i.e. `C:\msys`). Which one you
  66    choose depends on if you want 32 or 64 bit Rust.
  67 4. From there just navigate to where you have Rust's source code, configure and build it:
  68
  69         $ ./configure
  70         $ make && make install
  71
  72 ## Notes
  73
  74 Since the Rust compiler is written in Rust, it must be built by a
  75 precompiled "snapshot" version of itself (made in an earlier state of
  76 development). As such, source builds require a connection to the Internet, to
  77 fetch snapshots, and an OS that can execute the available snapshot binaries.
  78
  79 Snapshot binaries are currently built and tested on several platforms:
  80
  81 * Windows (7, 8, Server 2008 R2), x86 and x86-64 (64-bit support added in Rust 0.12.0)
  82 * Linux (2.6.18 or later, various distributions), x86 and x86-64
  83 * OSX 10.7 (Lion) or greater, x86 and x86-64
  84
  85 You may find that other platforms work, but these are our officially
  86 supported build environments that are most likely to work.
  87
  88 Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
  89 swap, it will take a very long time to build.
  90
  91 There is more advice about hacking on Rust in [CONTRIBUTING.md].
  92
  93 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
  94
  95 ## Getting help
  96
  97 The Rust community congregates in a few places:
  98
  99 * [StackOverflow] - Direct questions about using the language here.
 100 * [users.rust-lang.org] - General discussion, broader questions.
 101 * [/r/rust] - News and general discussion.
 102
 103 [StackOverflow]: http://stackoverflow.com/questions/tagged/rust
 104 [/r/rust]: http://reddit.com/r/rust
 105 [users.rust-lang.org]: http://users.rust-lang.org/
 106
 107 ## Contributing
 108
 109 To contribute to Rust, please see [CONTRIBUTING.md](CONTRIBUTING.md).
 110
 111 Rust has an [IRC] culture and most real-time collaboration happens in a
 112 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
 113 most popular channel is [#rust], a venue for general discussion about
 114 Rust, and a good place to ask for help,
 115
 116 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
 117 [#rust]: irc://irc.mozilla.org/rust
 118
 119 ## License
 120
 121 Rust is primarily distributed under the terms of both the MIT license
 122 and the Apache License (Version 2.0), with portions covered by various
 123 BSD-like licenses.
 124
 125 See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.