Go to file

bors 0935beba71 auto merge of #14486 : michaelwoerister/rust/unified_enum_rep, r=luqmana So far the DWARF information for enums was different for regular enums, univariant enums, Option-like enums, etc. Regular enums were encoded as unions of structs, while the other variants were encoded as bare structs. With the changes in this PR all enums are encoded as unions so that debuggers can reconstruct if something originally was a struct, a univariant enum, or an Option-like enum. For the latter case, information about the Null variant is encoded into the union field name. This information can then be used by the debugger to print a `None` value actually as `None` instead of `Some(0x0)`. The changes in this PR should also fix the regression reported in #14385 and #14411, but I want to close these only after I have confirmation from the original reporters that the issues are actually fixed for them.		2014-05-29 14:41:42 -07:00
man
mk	auto merge of #14476 : luqmana/rust/docs, r=alexcrichton	2014-05-28 18:21:34 -07:00
src	auto merge of #14486 : michaelwoerister/rust/unified_enum_rep, r=luqmana	2014-05-29 14:41:42 -07:00
.gitattributes
.gitignore
.gitmodules
.mailmap
.travis.yml
AUTHORS.txt
configure	Don't enable libcpp for llvm by default.	2014-05-28 19:54:58 -07:00
CONTRIBUTING.md	Change static.rust-lang.org to doc.rust-lang.org	2014-05-21 19:55:39 -07:00
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in
README.md	Change static.rust-lang.org to doc.rust-lang.org	2014-05-21 19:55:39 -07:00
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.