Go to file
bors 767e3ae86c auto merge of #6434 : alexcrichton/rust/less-implicit-vecs, r=bstrie
This closes #5204 and #6421.

This also removes the `vecs_implicitly_copyable` lint (although now reading #6421, this may not be desired?). If we want to leave it in, it at least removes it from the compiler.
2013-05-14 10:10:54 -07:00
doc Use static string with fail!() and remove fail!(fmt!()) 2013-05-14 16:36:23 +02:00
man Update license terms in manpage 2013-04-08 10:19:16 +02:00
mk Update make dependencies of librust 2013-05-13 13:47:05 -04:00
src Fix test fallout from removing vecs_implicitly_copyable 2013-05-14 12:25:19 -04:00
.gitattributes add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
.gitignore gitignore: Add build/ subdirectory 2013-04-17 13:58:42 -07:00
.gitmodules Support https protocol for git submodules for rust 2013-04-09 15:45:22 +05:30
AUTHORS.txt Update AUTHORS.txt w/ Brett Cannon, Diggory Hardy, Jack Moffitt, James Miller 2013-04-15 16:26:49 -07:00
CONTRIBUTING.md Contributing.md: remove spurious verb 2013-03-01 22:46:00 +01:00
COPYRIGHT add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
LICENSE-APACHE Update license, add license boilerplate to most files. Remainder will follow. 2012-12-03 17:12:14 -08:00
LICENSE-MIT tidy version numbers and copyright dates 2013-04-01 16:15:49 -07:00
Makefile.in Add #[cfg(debug)] flag to rust suite compilation. Closes #3068 2013-05-08 20:03:53 +10:00
README.md tidy version numbers and copyright dates 2013-04-01 16:15:49 -07:00
RELEASES.txt add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
configure configure: CFG_ADB for adb added 2013-05-04 00:46:52 +09: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.6.tar.gz
$ tar -xzf rust-0.6.tar.gz
$ cd rust-0.6
$ ./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.