README.md

   1 # The Rust Programming Language
   2
   3 This is a compiler for Rust, including standard libraries, tools and
   4 documentation.
   5
   6
   7 ## Installation
   8
   9 The Rust compiler currently must be built from a [tarball], unless you
  10 are on Windows, in which case using the [installer][win-exe] is
  11 recommended.
  12
  13 Since the Rust compiler is written in Rust, it must be built by
  14 a precompiled "snapshot" version of itself (made in an earlier state
  15 of development). As such, source builds require a connection to
  16 the Internet, to fetch snapshots, and an OS that can execute the
  17 available snapshot binaries.
  18
  19 Snapshot binaries are currently built and tested on several platforms:
  20
  21 * Windows (7, Server 2008 R2), x86 only
  22 * Linux (various distributions), x86 and x86-64
  23 * OSX 10.6 ("Snow Leopard") or greater, x86 and x86-64
  24
  25 You may find that other platforms work, but these are our "tier 1"
  26 supported build environments that are most likely to work.
  27
  28 > ***Note:*** Windows users should read the detailed
  29 > [getting started][wiki-start] notes on the wiki. Even when using
  30 > the binary installer the Windows build requires a MinGW installation,
  31 > the precise details of which are not discussed here.
  32
  33 To build from source you will also need the following prerequisite
  34 packages:
  35
  36 * g++ 4.4 or clang++ 3.x
  37 * python 2.6 or later (but not 3.x)
  38 * perl 5.0 or later
  39 * gnu make 3.81 or later
  40 * curl
  41
  42 Assuming you're on a relatively modern *nix system and have met the
  43 prerequisites, something along these lines should work.
  44
  45     $ curl -O http://static.rust-lang.org/dist/rust-0.7.tar.gz
  46     $ tar -xzf rust-0.7.tar.gz
  47     $ cd rust-0.7
  48     $ ./configure
  49     $ make && make install
  50
  51 You may need to use `sudo make install` if you do not normally have
  52 permission to modify the destination directory. The install locations
  53 can be adjusted by passing a `--prefix` argument to
  54 `configure`. Various other options are also supported, pass `--help`
  55 for more information on them.
  56
  57 When complete, `make install` will place several programs into
  58 `/usr/local/bin`: `rustc`, the Rust compiler; `rustdoc`, the
  59 API-documentation tool, and `rustpkg`, the Rust package manager and build system.
  60
  61 [wiki-start]: https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust
  62 [tarball]: http://static.rust-lang.org/dist/rust-0.7.tar.gz
  63 [win-exe]: http://static.rust-lang.org/dist/rust-0.7-install.exe
  64
  65
  66 ## License
  67
  68 Rust is primarily distributed under the terms of both the MIT license
  69 and the Apache License (Version 2.0), with portions covered by various
  70 BSD-like licenses.
  71
  72 See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.
  73
  74 ## More help
  75
  76 The [tutorial] is a good starting point.
  77
  78 [tutorial]: http://static.rust-lang.org/doc/tutorial.html