Go to file

Erick Tryzelaar 27e235b64a libsyntax and librustc: minor cleanup		2013-02-19 10:02:51 -08:00
doc	auto merge of #5029 : mcpherrinm/rust/master, r=catamorphism	2013-02-19 00:08:31 -08:00
man	Update manpage based on current usage message	2013-02-15 01:29:14 +01:00
mk	Attempt to solve make check test ambiguity betwen crate 'rust' and extratected doc 'rust'	2013-02-19 02:22:14 +01:00
src	libsyntax and librustc: minor cleanup	2013-02-19 10:02:51 -08:00
.gitignore	.settings/ added in .gitignore	2012-10-24 18:36:40 +03:00
.gitmodules	build: change libuv to point at joyent's repo and make unpatched build libuv work on mingw	2013-02-10 11:51:05 -08:00
AUTHORS.txt	Correct Zack Corr's email in AUTHORS.txt	2013-02-15 18:04:10 -08:00
configure	auto merge of #4876 : brson/rust/debuginfo, r=brson	2013-02-12 13:30:07 -08:00
CONTRIBUTING.md	Tweak the CONTRIBUTING.md file.	2013-02-01 17:34:09 -08:00
COPYRIGHT	Update license, add license boilerplate to most files. Remainder will follow.	2012-12-03 17:12:14 -08:00
LICENSE-APACHE	Update license, add license boilerplate to most files. Remainder will follow.	2012-12-03 17:12:14 -08:00
LICENSE-MIT	Update license, add license boilerplate to most files. Remainder will follow.	2012-12-03 17:12:14 -08:00
Makefile.in	Added rust convenience tool similar to go's go tool	2013-02-18 23:11:08 +01:00
README.md	Rename cargo to rustpkg and start over fresh	2013-02-15 18:04:10 -08:00
RELEASES.txt	`core::send_map` renamed to `core::hashmap`	2013-02-06 10:14:50 +01:00

README.md

The Rust Programming Language

This is a compiler for Rust, including standard libraries, tools and documentation.

Installation

The Rust compiler currently must be built from a tarball, unless you are on Windows, in which case using the installer is recommended.

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.

Snapshot binaries are currently built and tested on several platforms:

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

You may find that other platforms work, but these are our "tier 1" supported build environments that are most likely to work.

Note: Windows users should read the detailed getting started 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:

g++ 4.4 or clang++ 3.x
python 2.6 or later (but not 3.x)
perl 5.0 or later
gnu make 3.81 or later
curl

Assuming you're on a relatively modern *nix system and have met the prerequisites, something along these lines should work.

$ curl -O http://static.rust-lang.org/dist/rust-0.5.tar.gz
$ tar -xzf rust-0.5.tar.gz
$ cd rust-0.5
$ ./configure
$ make && make install

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.

When complete, make install will place several programs into /usr/local/bin: rustc, the Rust compiler; rustdoc, the API-documentation tool, and rustpkg, the Rust package manager and build system.

License

Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.

More help

The tutorial is a good starting point.