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 is slightly unusual in that it is written in Rust and
  10 therefore must be built by a precompiled "snapshot" version of itself (made in
  11 an earlier state of development). As such, source builds require that:
  12
  13 * You are connected to the internet, to fetch snapshots.
  14
  15 * You can at least execute snapshot binaries of one of the forms we offer
  16   them in. Currently we build and test snapshots on:
  17
  18   * Windows (7, server 2008 r2) x86 only
  19   * Linux 2.6.x (various distributions) x86 and x86-64
  20   * OSX 10.6 ("Snow leopard") or 10.7 ("Lion") x86 and x86-64
  21
  22 You may find other platforms work, but these are our "tier 1" supported build
  23 environments that are most likely to work. Further platforms will be added to
  24 the list in the future via cross-compilation.
  25
  26 To build from source you will also need the following prerequisite packages:
  27
  28 * g++ 4.4 or clang++ 3.x
  29 * python 2.6 or later
  30 * perl 5.0 or later
  31 * gnu make 3.81 or later
  32 * curl
  33
  34 Assuming you're on a relatively modern Linux/OSX system and have met the
  35 prerequisites, something along these lines should work:
  36
  37     $ tar -xzf rust-0.3.tar.gz
  38     $ cd rust-0.3
  39     $ ./configure
  40     $ make && make install
  41
  42 When complete, make install will place the following programs into
  43 /usr/local/bin:
  44
  45 * rustc, the Rust compiler
  46 * rustdoc, the API-documentation tool
  47 * cargo, the Rust package manager
  48
  49 In addition to a manual page under /usr/local/share/man and a set of host and
  50 target libraries under /usr/local/lib/rustc.
  51
  52 The install locations can be adjusted by passing a --prefix argument to
  53 configure. Various other options are also supported, pass --help for more
  54 information on them.
  55
  56
  57 ## License
  58
  59 Rust is primarily distributed under the terms of the MIT license, with
  60 portions covered by various BSD-like licenses.
  61
  62 See LICENSE.txt for complete terms of copyright and redistribution.
  63
  64
  65 ## More help
  66
  67 The [tutorial](http://dl.rust-lang.org/doc/tutorial.html) is a good
  68 starting point.