Go to file

bors 8d50d6a93c auto merge of #14346 : alexcrichton/rust/rustdoc-external-crates, r=pcwalton This commit alters rustdoc to crawl the metadata of upstream libraries in order to fill in default methods for traits implemented in downstream crates. This, for example, documents the `insert` function on hash maps. This is a fairly lossy extraction from the metadata. Documentation and attributes are lost, but they aren't used anyway. Unfortunately, argument names are also lost because they are not present in the metadata. Source links are also lost because the spans are not serialized. While not perfect, it appears that presenting this documentation through rustdoc is much better than nothing, so I wanted to land this to allow iteration on it later on.		2014-05-22 10:31:25 -07:00
man	Get rid of the android-cross-path flag to rustc.	2014-05-14 02:16:14 -04:00
mk	auto merge of #14334 : brson/rust/deoxidize, r=alexcrichton	2014-05-21 13:11:28 -07:00
src	auto merge of #14346 : alexcrichton/rust/rustdoc-external-crates, r=pcwalton	2014-05-22 10:31:25 -07:00
.gitattributes	make sure jemalloc valgrind support is enabled	2014-05-11 20:05:22 -04:00
.gitignore
.gitmodules	add back jemalloc to the tree	2014-05-10 19:58:17 -04:00
.mailmap
.travis.yml
AUTHORS.txt
configure	Make configure respect (and save) values for `CC`, `CXX`, `CFLAGS`, etc.	2014-05-20 21:37:08 +02:00
CONTRIBUTING.md
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in	mk: Don't run benchmarks with `make check`	2014-05-15 13:50:14 -07:00
README.md
RELEASES.txt

README.md

The Rust Programming Language

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

Quick Start

Download a binary installer for your platform.
Read the tutorial.
Enjoy!

Note: Windows users can read the detailed getting started notes on the wiki.

Building from Source

Make sure you have installed the dependencies:
- g++ 4.7 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
- git
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-nightly.tar.gz
 $ tar -xzf rust-nightly.tar.gz
 $ cd rust-nightly
```
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
```
Note: 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, and rustdoc, the API-documentation tool. 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, 8, Server 2008 R2), x86 only
Linux (2.6.18 or later, various distributions), x86 and x86-64
OSX 10.7 (Lion) or greater, x86 and x86-64

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

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

There is a lot 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.