mirror of https://github.com/rust-lang/rust.git synced 2024-12-23 22:14:15 +00:00

Empowering everyone to build reliable and efficient software.

Go to file

Tyler Bindon c89afc3971 Fix Option camel case in a compile-fail test The compile fails for another reason, that triggers before the the failure for non-camel cased option, some or none undefined errors.		2013-01-25 19:42:24 -07:00
doc	doc typo	2013-01-25 11:58:33 -08:00
man	Move the description of -(W\|A\|D\|F) into the `-W help` message	2012-10-10 16:48:23 -07:00
mk	Start running the libsyntax unit tests. #4618	2013-01-25 14:49:02 -08:00
src	Fix Option camel case in a compile-fail test	2013-01-25 19:42:24 -07:00
.gitignore	.settings/ added in .gitignore	2012-10-24 18:36:40 +03:00
.gitmodules	Update libuv.	2012-02-02 17:39:47 -08:00
AUTHORS.txt	Add Cody Schroeder to AUTHORS	2013-01-25 18:05:17 -08:00
configure	Support ARM and Android	2013-01-13 16:43:39 -08:00
CONTRIBUTING.md	Add an xfailed test case and a CONTRIBUTING.md file	2012-12-27 14:58:45 -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	Support ARM and Android	2013-01-13 16:43:39 -08:00
README.md	Wrap lines	2012-12-28 13:41:25 -08:00
RELEASES.txt	Mention module/type namespace merge in release notes	2012-12-19 14:43:58 -08: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.

$ wget 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 cargo, the Rust package manager.

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.