mirror of https://github.com/rust-lang/rust.git synced 2025-01-10 14:57:14 +00:00

Empowering everyone to build reliable and efficient software.

Go to file

Björn Steinbrink 56671cb357 Prefer GEP instructions over weird pointer casting There are two places left where we used to only know the byte size of/offset into an array and had to cast to i8 and back to get the right addresses. But by now, we always know the sizes in terms of the number of elements in the array. In fact we have to add an extra Mul instruction so we can use the weird cast-to-u8 code. So we should really just embrace our new knowledge and use simple GEPs to do the address calculations. Additionally, the pointer calculations in bind_subslice_pat don't handle zero-sized types correctly, producing slices that point outside the array that is being matched against. Using GEP fixes that as well. Fixes #3729		2015-01-13 23:47:38 +01:00
man	Man page/--help dialog fix	2015-01-03 11:34:01 -08:00
mk	auto merge of #20802 : huonw/rust/book-css, r=steveklabnik	2015-01-10 05:55:07 +00:00
src	Prefer GEP instructions over weird pointer casting	2015-01-13 23:47:38 +01: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	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	Add new authors, more relnotes	2015-01-06 16:37:38 -08:00
configure	"The Rust Programming Language"	2015-01-08 12:02:11 -05:00
CONTRIBUTING.md	Put links to discuss.rust-lang.org and #rust-internals in CONTRIBUTING.md	2015-01-02 15:42:38 -08: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	Fix incorrect link in Makefile.in documentation	2014-12-28 22:42:12 +01:00
README.md	"The Rust Programming Language"	2015-01-08 12:02:11 -05: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

Download a binary installer for your platform.
Read The Rust Programming Language.
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 Rust Programming Language.
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.