Go to file

bors 77eeddaa48 auto merge of #11501 : alexcrichton/rust/dox, r=brson The official documentation sorely needs an explanation of the rust runtime and what it is exactly, and I want this guide to provide that information. I'm unsure of whether I've been too light on some topics while too heavy on others. I also feel like a few things are still missing. As always, feedback is appreciated, especially about things you'd like to see written about!		2014-01-13 23:26:36 -08:00
doc	auto merge of #11501 : alexcrichton/rust/dox, r=brson	2014-01-13 23:26:36 -08:00
man	remove the rusti command	2013-10-16 22:54:38 -04:00
mk	auto merge of #11501 : alexcrichton/rust/dox, r=brson	2014-01-13 23:26:36 -08:00
src	auto merge of #11531 : brson/rust/yetmoreandroidfixes, r=alexcrichton	2014-01-13 21:51:37 -08:00
.gitattributes	drop the linenoise library	2013-10-16 22:57:51 -04:00
.gitignore	doc: build the docs for librustpkg	2014-01-11 19:13:59 -08:00
.gitmodules	Update submodules to point to rust-lang repos	2014-01-09 20:21:22 -08:00
.mailmap	…
AUTHORS.txt	Update AUTHORS.txt	2014-01-06 15:01:34 -08:00
CONTRIBUTING.md	Various READMEs and docs cleanup	2014-01-11 19:41:31 +01:00
COPYRIGHT	Update some copyright dates	2014-01-08 18:04:43 -08:00
LICENSE-APACHE	…
LICENSE-MIT	Update some copyright dates	2014-01-08 18:04:43 -08:00
Makefile.in	Bump version to 0.10-pre	2014-01-12 17:45:22 -08:00
README.md	Various READMEs and docs cleanup	2014-01-11 19:41:31 +01:00
RELEASES.txt	More 0.9 release notes	2014-01-06 14:52:16 -08:00
configure	dox: Write a guide to the rust runtime	2014-01-13 23:22:07 -08: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 and MinGW.
Read the tutorial.
Enjoy!

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

Linux / OS X

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
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.9.tar.gz
 $ tar -xzf rust-0.9.tar.gz
 $ cd rust-0.9
```
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; 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 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.