Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 68 lines (45 sloc) 2.147 kB
a08c5aa @brson Capitalize 'Rust Programming Language' in README.md
brson authored
1 # The Rust Programming Language
62c4d2c @thoughtpolice Add an INSTALL.txt and make it part of the source distribution
thoughtpolice authored
2
c92d2ed @brson Merge README.txt and INSTALL.txt into README.md
brson authored
3 This is a compiler for Rust, including standard libraries, tools and
4 documentation.
5
6
7 ## Installation
62c4d2c @thoughtpolice Add an INSTALL.txt and make it part of the source distribution
thoughtpolice authored
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 * Windows (7, server 2008 r2) x86 only
18 * Linux 2.6.x (various distributions) x86 and x86-64
19 * OSX 10.6 ("Snow leopard") or 10.7 ("Lion") x86 and x86-64
20
21 You may find other platforms work, but these are our "tier 1" supported build
22 environments that are most likely to work. Further platforms will be added to
23 the list in the future via cross-compilation.
24
25 To build from source you will also need the following prerequisite packages:
26
27 * g++ 4.4 or clang++ 3.x
28 * python 2.6 or later
29 * perl 5.0 or later
30 * gnu make 3.81 or later
31 * curl
32
33 Assuming you're on a relatively modern Linux/OSX system and have met the
34 prerequisites, something along these lines should work:
35
56273e3 @catamorphism Bump version in INSTALL.txt
catamorphism authored
36 $ tar -xzf rust-0.2.tar.gz
37 $ cd rust-0.2
62c4d2c @thoughtpolice Add an INSTALL.txt and make it part of the source distribution
thoughtpolice authored
38 $ ./configure
39 $ make && make install
40
41 When complete, make install will place the following programs into
42 /usr/local/bin:
43
44 * rustc, the Rust compiler
45 * rustdoc, the API-documentation tool
46 * cargo, the Rust package manager
47
48 In addition to a manual page under /usr/local/share/man and a set of host and
49 target libraries under /usr/local/lib/rustc.
50
51 The install locations can be adjusted by passing a --prefix argument to
52 configure. Various other options are also supported, pass --help for more
53 information on them.
54
55
c92d2ed @brson Merge README.txt and INSTALL.txt into README.md
brson authored
56 ## License
57
58 Rust is primarily distributed under the terms of the MIT license, with
59 portions covered by various BSD-like licenses.
60
61 See LICENSE.txt for complete terms of copyright and redistribution.
62
62c4d2c @thoughtpolice Add an INSTALL.txt and make it part of the source distribution
thoughtpolice authored
63
c92d2ed @brson Merge README.txt and INSTALL.txt into README.md
brson authored
64 ## More help
62c4d2c @thoughtpolice Add an INSTALL.txt and make it part of the source distribution
thoughtpolice authored
65
c92d2ed @brson Merge README.txt and INSTALL.txt into README.md
brson authored
66 The [tutorial](http://dl.rust-lang.org/doc/tutorial.html) is a good
67 starting point.
Something went wrong with that request. Please try again.