mirror of https://github.com/rust-lang/rust.git synced 2024-12-26 23:45:30 +00:00

Empowering everyone to build reliable and efficient software.

Go to file

Manish Goregaokar 99e39f4927 Clean up visit_attribute in feature_gate.rs - We shouldn't be using `check_name` here at all - `contains_name(ref_slice(foo), bar)` is redundant, `contains_name` just iterates over its first arg and calls `check_name` - match would be better than a bunch of ifs		2015-02-16 11:49:09 +05:30
man	rustc: Recognize `-L framework=foo`	2015-02-04 13:54:49 -08:00
mk	Rollup merge of #22256 - brson:installer-next, r=alexcrichton	2015-02-15 18:42:48 +05:30
src	Clean up visit_attribute in feature_gate.rs	2015-02-16 11:49:09 +05:30
.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	Allow travis to use newer-faster infrastructure for building. http://blog.travis-ci.com/2014-12-17-faster-builds-with-container-based-infrastructure/	2015-01-01 02:00:29 -05:00
AUTHORS.txt	Correct Orpheus Lummis's email and name	2015-01-28 10:04:56 -05:00
configure	Auto merge of #22041 - semarie:configure-compat, r=alexcrichton	2015-02-14 07:10:52 +00:00
CONTRIBUTING.md	discuss.rust-lang.org -> internals.rust-lang.org	2015-01-27 15:44:05 -08:00
COPYRIGHT	copyright: update paths and entries	2015-01-22 15:45:47 +01:00
LICENSE-APACHE	Update license, add license boilerplate to most files. Remainder will follow.	2012-12-03 17:12:14 -08:00
LICENSE-MIT	update mit-license and copyright	2015-01-10 23:35:33 -05:00
Makefile.in	mk: Add tidy commands to 'make tips'	2015-02-05 14:37:16 -08:00
README.md	Remove some irrelevant text from README	2015-02-12 20:36:21 -08:00
RELEASES.md	Link to http://rustbyexample.com/	2015-01-09 08:25:42 +01:00

README.md

The Rust Programming Language

This is a compiler for Rust, including standard libraries, tools and documentation.

Quick Start

Read "Installing Rust" from The Book.

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)
- 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/rustc-nightly-src.tar.gz
 $ tar -xzf rustc-nightly-src.tar.gz
 $ cd rustc-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.

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.

# choose one based on platform
$ pacman -S mingw-w64-i686-toolchain
$ pacman -S mingw-w64-x86_64-toolchain

$ pacman -S base-devel

With that now start mingw32_shell.bat or mingw64_shell.bat from where you installed MSYS2 (i.e. C:\msys). Which one you choose depends on if you want 32 or 64 bit Rust.
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 - Direct questions about using the language here.
users.rust-lang.org - General discussion, broader questions.
internals.rust-lang.org - For development of the Rust language itself.
/r/rust - News and general discussion.

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.