2012-07-10 05:18:37 +00:00
|
|
|
# The Rust Programming Language
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-07-10 05:13:48 +00:00
|
|
|
This is a compiler for Rust, including standard libraries, tools and
|
|
|
|
documentation.
|
|
|
|
|
|
|
|
|
|
|
|
## Installation
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
The Rust compiler currently must be built from a [tarball], unless you
|
|
|
|
are on Windows, in which case using the [installer][win-exe] is
|
|
|
|
recommended.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
Since the Rust compiler is written in Rust, it must be built by
|
|
|
|
a precompiled "snapshot" version of itself (made in an earlier state
|
|
|
|
of development). As such, source builds require a connection to
|
|
|
|
the Internet, to fetch snapshots, and an OS that can execute the
|
|
|
|
available snapshot binaries.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
Snapshot binaries are currently built and tested on several platforms:
|
2012-07-10 05:20:32 +00:00
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
* Windows (7, Server 2008 R2), x86 only
|
|
|
|
* Linux (various distributions), x86 and x86-64
|
|
|
|
* OSX 10.6 ("Snow Leopard") or greater, x86 and x86-64
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
You may find that other platforms work, but these are our "tier 1"
|
|
|
|
supported build environments that are most likely to work.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
> ***Note:*** Windows users should read the detailed
|
|
|
|
> [getting started][wiki-start] notes on the wiki. Even when using
|
|
|
|
> the binary installer the Windows build requires a MinGW installation,
|
|
|
|
> the precise details of which are not discussed here.
|
|
|
|
|
|
|
|
To build from source you will also need the following prerequisite
|
|
|
|
packages:
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-07-10 05:20:32 +00:00
|
|
|
* g++ 4.4 or clang++ 3.x
|
2012-10-11 00:56:38 +00:00
|
|
|
* python 2.6 or later (but not 3.x)
|
2012-07-10 05:20:32 +00:00
|
|
|
* perl 5.0 or later
|
|
|
|
* gnu make 3.81 or later
|
|
|
|
* curl
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
Assuming you're on a relatively modern *nix system and have met the
|
|
|
|
prerequisites, something along these lines should work.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-12-21 23:35:15 +00:00
|
|
|
$ wget http://static.rust-lang.org/dist/rust-0.5.tar.gz
|
2012-12-20 02:03:03 +00:00
|
|
|
$ tar -xzf rust-0.5.tar.gz
|
|
|
|
$ cd rust-0.5
|
2012-01-23 21:53:12 +00:00
|
|
|
$ ./configure
|
|
|
|
$ make && make install
|
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
You may need to use `sudo make install` if you do not normally have
|
|
|
|
permission to modify the destination directory. The install locations
|
|
|
|
can be adjusted by passing a `--prefix` argument to
|
|
|
|
`configure`. Various other options are also supported, pass `--help`
|
|
|
|
for more information on them.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
When complete, `make install` will place several programs into
|
|
|
|
`/usr/local/bin`: `rustc`, the Rust compiler; `rustdoc`, the
|
|
|
|
API-documentation tool, and `cargo`, the Rust package manager.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
[wiki-start]: https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust
|
2012-12-21 23:35:15 +00:00
|
|
|
[tarball]: http://static.rust-lang.org/dist/rust-0.5.tar.gz
|
|
|
|
[win-exe]: http://static.rust-lang.org/dist/rust-0.5-install.exe
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
|
|
|
2012-07-10 05:13:48 +00:00
|
|
|
## License
|
|
|
|
|
2012-12-22 14:44:20 +00:00
|
|
|
Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with
|
2012-07-10 05:13:48 +00:00
|
|
|
portions covered by various BSD-like licenses.
|
|
|
|
|
2012-12-22 14:44:20 +00:00
|
|
|
See LICENSE-APACHE and LICENSE-MIT for details.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-07-10 05:13:48 +00:00
|
|
|
## More help
|
2012-01-23 21:53:12 +00:00
|
|
|
|
2012-09-20 08:08:11 +00:00
|
|
|
The [tutorial] is a good starting point.
|
|
|
|
|
2012-12-21 23:35:15 +00:00
|
|
|
[tutorial]: http://static.rust-lang.org/doc/tutorial.html
|