mirror of https://github.com/rust-lang/rust.git synced 2024-11-01 06:51:58 +00:00

Empowering everyone to build reliable and efficient software.

Go to file

Yuri Kunde Schlesner 337e62e4d6 Allow codepoints 128-255 in fourc!! Codepoints with those values will be interpreted as bytes with their raw codepoint value. ('\xAB' -> 0xABu8, etc.) Codepoints > 255 remain forbidden.		2014-02-08 23:40:17 -06:00
man	Redesign output flags for rustc	2014-02-06 11:14:13 -08:00
mk	Converted fourcc! to loadable syntax extension	2014-02-08 23:40:17 -06:00
src	Allow codepoints 128-255 in fourc!!	2014-02-08 23:40:17 -06:00
.gitattributes	drop the linenoise library	2013-10-16 22:57:51 -04:00
.gitignore	doc: add license information for gen. files	2014-02-07 20:50:15 +01:00
.gitmodules	Update submodules to point to rust-lang repos	2014-01-09 20:21:22 -08:00
.mailmap	.mailmap: tolerate different names, emails in shortlog	2013-06-05 23:26:00 +05:30
AUTHORS.txt	Update extract-tests.py to use same test directives as rustdoc.	2014-01-28 14:52:36 -06:00
configure	Upgrade LLVM	2014-01-29 23:43:39 -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	Update license, add license boilerplate to most files. Remainder will follow.	2012-12-03 17:12:14 -08:00
LICENSE-MIT	Update some copyright dates	2014-01-08 18:04:43 -08:00
Makefile.in	Remove VPATH usage in Makefiles	2014-02-02 10:59:14 -08:00
README.md	Remove rustpkg.	2014-02-02 03:08:56 -05:00
RELEASES.txt	More 0.9 release notes	2014-01-06 14:52:16 -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, 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.