Go to file

bors 774d5eb0b0 auto merge of #15670 : epdtry/rust/fast-archive-builder, r=alexcrichton When rustc produces an rlib, it includes the contents of each static library required by the crate. Currently each static library is added individually, by extracting the library with `ar x` and adding the objects to the rlib using `ar r`. Each `ar r` has significant overhead - it appears to scan through the full contents of the rlib before adding the new files. This patch avoids most of the overhead by adding all library objects (and other rlib components) at once using a single `ar r`. When building `librustc` (on Linux, using GNU ar), this patch gives a 60-80% reduction in linking time, from 90s to 10s one machine I tried and 25s to 8s on another. (Though `librustc` is a bit of a special case - it's a very large crate, so the rlib is large to begin with, and it also relies on a total of 45 static libraries due to the way LLVM is organized.) More reasonable crates such as `libstd` and `libcore` also get a small reduction in linking time (just from adding metadata, bitcode, and object code in one `ar` invocation instead of three), but this is not very noticeable since the time there is small to begin with (around 1s).		2014-07-30 07:41:11 +00:00
man	rustc.1: fix typo	2014-07-16 08:01:59 +02:00
mk	mk: Print grammar info message like others	2014-07-25 14:32:34 -07:00
src	auto merge of #15670 : epdtry/rust/fast-archive-builder, r=alexcrichton	2014-07-30 07:41:11 +00:00
.gitattributes	webfonts: proper fix	2014-07-08 20:29:36 +02:00
.gitignore	Move llvm bindings to their own crate	2014-07-14 12:27:07 -07:00
.gitmodules	add back jemalloc to the tree	2014-05-10 19:58:17 -04:00
.mailmap
.travis.yml	travis: Move from travis_wait to time-passes	2014-07-01 20:21:16 -07:00
AUTHORS.txt	Updated release notes for 0.11.0	2014-06-30 07:25:58 -07:00
configure	configure: Add --enable-dist-host-only flag	2014-07-23 12:04:27 -07:00
CONTRIBUTING.md	Update repo location	2014-06-16 18:16:36 -07:00
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in	Shuffle around check-lexer conditions	2014-07-21 18:38:40 -07:00
README.md	fix typo in readme	2014-06-30 11:17:25 +02:00
RELEASES.txt	Update RELEASES.txt	2014-07-05 00:22:59 -04:00

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/rust-lang/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.
Read the tutorial.
Enjoy!

Building on Windows

To easily build on windows we can use MSYS2:

Grab the latest MSYS2 installer and go through the installer.
Now from the MSYS2 terminal we want to install the mingw64 toolchain and the other tools we need.
```
 $ pacman -S mingw-w64-i686-toolchain
 $ pacman -S base-devel
```
With that now start mingw32_shell.bat from where you installed MSYS2 (i.e. C:\msys).
From there just navigate to where you have Rust's source code, configure and build it:
```
 $ ./configure --build=i686-pc-mingw32
 $ make && make install
```

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.