Go to file

blake2-ppc 4de9bca4d8 std::str: Tune CharSplitIterator after benchmarks Implement Huon Wilson's suggestions (since the benchmarks agree!). Use `self.sep.matches(byte as char) && byte < 128u8` to match in the only_ascii case so that mistaken matches outside the ascii range can't create invalid substrings. Put the conditional on only_ascii outside the loop.		2013-08-26 13:30:46 +02:00
doc	Talk about trait bounds in the tutorial.	2013-08-23 19:20:34 -04:00
man	Updated rustpkg man page to match 0.7	2013-07-08 23:03:20 +10:00
mk	auto merge of #8722 : graydon/rust/2013-08-23-test-shard, r=msullivan	2013-08-24 02:21:27 -07:00
src	std::str: Tune CharSplitIterator after benchmarks	2013-08-26 13:30:46 +02:00
.gitattributes	Force line ending of '.in' files in jemalloc to LF	2013-08-24 22:20:20 +05:30
.gitignore	Ignore the generated docs for libextra	2013-05-25 17:07:18 +10:00
.gitmodules	Update LLVM	2013-08-04 10:58:22 -07:00
.mailmap	.mailmap: tolerate different names, emails in shortlog	2013-06-05 23:26:00 +05:30
AUTHORS.txt	Update AUTHORS.txt	2013-06-21 00:54:17 -04:00
configure	enable tests for the container tutorial	2013-08-20 22:05:46 -04:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2013-06-13 15:41:34 -06:00
COPYRIGHT	add gitattributes and fix whitespace issues	2013-05-03 20:01:42 -04:00
LICENSE-APACHE
LICENSE-MIT
Makefile.in	Define cfg(rtopt) when optimizing. Turn off runtime sanity checks	2013-08-23 21:19:59 -07:00
README.md	Reorganize README to make it more clear.	2013-07-19 20:52:16 -04:00
RELEASES.txt	More 0.7 release notes	2013-06-30 15:02:52 -07:00

README.md

The Rust Programming Language

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

Quick Start

Windows

Download and use the installer.
Read the tutorial.
Enjoy!

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.

Linux / OS X

Install the prerequisites (if not already installed)
- 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
Download and build Rust You can either download a tarball or build directly from the repo.

To build from the tarball do:
```
 $ curl -O http://static.rust-lang.org/dist/rust-0.7.tar.gz
 $ tar -xzf rust-0.7.tar.gz
 $ cd rust-0.7
```
Or to build from the repo do:
```
 $ git clone https://github.com/mozilla/rust.git
 $ cd rust
```
Now that you have Rust's source code, you can configure and build it:
```
 $ ./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.
Read the tutorial.
Enjoy!

Notes

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.

Rust currently needs about 1.8G of RAM to build without swapping; if it hits swap, it will take a very long time to build.

There is lots more documentation in the wiki.

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.