mirror of https://github.com/rust-lang/rust.git synced 2024-12-02 19:53:46 +00:00

Empowering everyone to build reliable and efficient software.

Go to file

Alex Crichton 2af8155bee rollup merge of #19898 : Aatch/issue-19684 #16081 fixed an issue where a nested return statement would cause incorrect behaviour due to the inner return writing over the return stack slot that had already been written too. However, the check was very broad and picked many cases that wouldn't ever be affected by this issue. As a result, the number of allocas increased dramatically and therefore stack-size increased. LLVM is not able to remove all of the extraneous allocas. Any code that had multiple return values in a compound expression at the end of a function (including loops) would be hit by the issue. The check now uses a control-flow graph to only consider the case when the inner return is executed conditionally. By itself, this narrowed definition causes #15763 to return, so the control-flow graph is also used to avoid passing the return slot as a destination when the result won't be used. This change allows the stack-size of the main rustc task to be reduced to 8MB from 32MB.		2014-12-21 09:26:41 -08:00
man	auto merge of #17793 : simias/rust/master, r=huonw	2014-10-10 14:57:03 +00:00
mk	Split resolve from rustc::middle into rustc_resolve.	2014-12-20 07:28:47 +02:00
src	rollup merge of #19898 : Aatch/issue-19684	2014-12-21 09:26:41 -08:00
.gitattributes	webfonts: proper fix	2014-07-08 20:29:36 +02:00
.gitignore	gitignore: Add the autogenerated/downloaded unicode data files.	2014-08-03 17:32:53 +10:00
.gitmodules	Use rust-installer for installation	2014-12-11 17:14:17 -08:00
.mailmap	Update .mailmap	2014-10-23 23:01:31 +02:00
.travis.yml	travis: Fix for real this time	2014-10-03 07:25:10 -07:00
AUTHORS.txt	Add myself as an author	2014-11-19 13:18:34 -05:00
configure	Remove mentions of sundown.	2014-12-11 16:36:11 -05:00
CONTRIBUTING.md	Update CONTRIBUTING.md with new issues policy	2014-09-22 12:46:24 +12:00
COPYRIGHT	Update COPYRIGHT to better reflect the current repo	2014-10-06 10:55:39 -07:00
LICENSE-APACHE	Update license, add license boilerplate to most files. Remainder will follow.	2012-12-03 17:12:14 -08:00
LICENSE-MIT	Change the licence holder to The Rust Project Developers	2014-05-03 23:59:24 +02:00
Makefile.in	debuginfo: Add script that allows to conveniently start LLDB in "rust-mode"	2014-11-26 15:58:17 +01:00
README.md	auto merge of #17876 : ruud-v-a/rust/patch-1, r=alexcrichton	2014-10-13 21:32:43 +00:00
RELEASES.md	More relnotes tweaks	2014-10-07 13:44:41 -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 guide.
Enjoy!

Note: Windows users can read the detailed using Rust on Windows 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 https://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 guide.
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
 $ 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 and x86-64 (64-bit support added in Rust 0.12.0)
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.

Getting help and getting involved

The Rust community congregates in a few places:

StackOverflow - Get help here.
/r/rust - General discussion.
discuss.rust-lang.org - For development of the Rust language itself.

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.