33This is a compiler for Rust, including standard libraries, tools and
44documentation.
55
6+ ## Quick Start
67
7- ## Installation
8+ ### Windows
89
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.
10+ 1 . Download and use the [ installer ] [ win-exe ] .
11+ 2 . Read the [ tutorial ] .
12+ 2 . Enjoy!
1213
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.
14+ > *** Note:*** Windows users should read the detailed
15+ > [ getting started] [ wiki-start ] notes on the wiki. Even when using
16+ > the binary installer the Windows build requires a MinGW installation,
17+ > the precise details of which are not discussed here.
18+
19+ [ tutorial ] : http://static.rust-lang.org/doc/tutorial.html
20+ [ wiki-start ] : https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust
21+ [ win-exe ] : http://static.rust-lang.org/dist/rust-0.7-install.exe
22+
23+ ### Linux / OS X
24+
25+ 1 . Install the prerequisites (if not already installed)
26+ * g++ 4.4 or clang++ 3.x
27+ * python 2.6 or later (but not 3.x)
28+ * perl 5.0 or later
29+ * gnu make 3.81 or later
30+ * curl
31+ 2 . Download and build Rust
32+ You can either download a [ tarball] or build directly from the [ repo] .
33+
34+ To build from the [ tarball] do:
35+
36+ $ curl -O http://static.rust-lang.org/dist/rust-0.7.tar.gz
37+ $ tar -xzf rust-0.7.tar.gz
38+ $ cd rust-0.7
39+
40+ Or to build from the [ repo] do:
41+
42+ $ git clone https://github.com/mozilla/rust.git
43+ $ cd rust
44+
45+ Now that you have Rust's source code, you can configure and build it:
46+
47+ $ ./configure
48+ $ make && make install
49+
50+ You may need to use ` sudo make install ` if you do not normally have
51+ permission to modify the destination directory. The install locations can
52+ be adjusted by passing a ` --prefix ` argument to ` configure ` . Various other
53+ options are also supported, pass ` --help ` for more information on them.
54+
55+ When complete, ` make install ` will place several programs into
56+ ` /usr/local/bin ` : ` rustc ` , the Rust compiler; ` rustdoc ` , the
57+ API-documentation tool, and ` rustpkg ` , the Rust package manager and build
58+ system.
59+ 3 . Read the [ tutorial] .
60+ 4 . Enjoy!
61+
62+ [ repo ] : https://github.com/mozilla/rust
63+ [ tarball ] : http://static.rust-lang.org/dist/rust-0.7.tar.gz
64+ [ tutorial ] : http://static.rust-lang.org/doc/tutorial.html
65+
66+ ## Notes
67+
68+ Since the Rust compiler is written in Rust, it must be built by a
69+ precompiled "snapshot" version of itself (made in an earlier state of
70+ development). As such, source builds require a connection to the Internet, to
71+ fetch snapshots, and an OS that can execute the available snapshot binaries.
1872
1973Snapshot binaries are currently built and tested on several platforms:
2074
@@ -25,42 +79,12 @@ Snapshot binaries are currently built and tested on several platforms:
2579You may find that other platforms work, but these are our "tier 1"
2680supported build environments that are most likely to work.
2781
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
82+ Rust currently needs about 1.8G of RAM to build without swapping; if it hits
83+ swap, it will take a very long time to build.
5084
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.
85+ There is lots more documentation in the [ wiki] .
5686
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
87+ [ wiki ] : https://github.com/mozilla/rust/wiki
6488
6589
6690## License
@@ -71,8 +95,3 @@ BSD-like licenses.
7195
7296See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.
7397
74- ## More help
75-
76- The [ tutorial] is a good starting point.
77-
78- [ tutorial ] : http://static.rust-lang.org/doc/tutorial.html
0 commit comments