Go to file

Ivan Petkov 3a0d8fd980 rustdoc: #13771 : Make html links inside paragraphs more readable All links inside docblocks will have their color set to `#4e8bca` (a light blue color to contrast against the black text). This color also offers a visible contrast from the surrounding text if viewed as grayscale, making it suitable for accessability. Docblock links will also be underlined when hovered over.		2014-04-28 20:55:10 -07:00
man	auto merge of #13557 : FlaPer87/rust/ls-behind-z, r=brson	2014-04-17 01:31:27 -07:00
mk	auto merge of #13744 : adrientetar/rust/derp, r=brson	2014-04-25 18:26:33 -07:00
src	rustdoc: #13771 : Make html links inside paragraphs more readable	2014-04-28 20:55:10 -07:00
.gitattributes	dist: Tweak the OSX pkg installer	2014-03-28 18:29:29 -07:00
.gitignore	Add /dist/ to .gitignore	2014-03-09 14:17:27 -07:00
.gitmodules
.mailmap
.travis.yml	Let travis check docs for stage1	2014-03-20 10:20:08 +01:00
AUTHORS.txt	Update AUTHORS.txt for 0.10	2014-04-02 16:57:41 -07:00
configure	llvm: Add an option to statically link libstdc++	2014-04-17 11:39:51 -07:00
CONTRIBUTING.md
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in	auto merge of #13142 : alexcrichton/rust/issue-13118, r=brson	2014-03-27 17:11:58 -07:00
README.md	Add git to README.md dependency list because configure requires it	2014-04-18 14:50:31 -04:00
RELEASES.txt	Minor adjustments to the 0.10 release notes.	2014-04-02 16:43:30 -07: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.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
- 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.