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

Empowering everyone to build reliable and efficient software.

Go to file

Alex Crichton 6ac34926a4 std: User a smaller stdin buffer on windows Apparently windows doesn't like reading from stdin with a large buffer size, and it also apparently is ok with a smaller buffer size. This changes the reader returned by stdin() to return an 8k buffered reader for stdin rather than a 64k buffered reader. Apparently libuv has run into this before, taking a peek at their code, with a specific comment in their console code saying that "ReadConsole can't handle big buffers", which I presume is related to invoking ReadFile as if it were a file descriptor. Closes #13304		2014-04-08 00:03:12 -07:00
man	Bump version to 0.11-pre	2014-04-03 16:28:46 -07:00
mk	mk: Pass the name of the make command to maketest.py	2014-04-06 15:55:43 -07:00
src	std: User a smaller stdin buffer on windows	2014-04-08 00:03:12 -07:00
.gitattributes	dist: Tweak the OSX pkg installer	2014-03-28 18:29:29 -07:00
.gitignore	Add /dist/ to .gitignore	2014-03-09 14:17:27 -07:00
.gitmodules	Build compiler-rt and link it to all crates, similarly to morestack.	2014-02-11 15:59:59 -08:00
.mailmap	.mailmap: tolerate different names, emails in shortlog	2013-06-05 23:26:00 +05:30
.travis.yml	Let travis check docs for stage1	2014-03-20 10:20:08 +01:00
AUTHORS.txt	Update AUTHORS.txt for 0.10	2014-04-02 16:57:41 -07:00
configure	configure: Accept LLVM 3.4.X during configuration	2014-03-30 13:54:57 -07: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	auto merge of #13142 : alexcrichton/rust/issue-13118, r=brson	2014-03-27 17:11:58 -07:00
README.md	Fixed broken tutorial link	2014-04-06 16:06:46 -04:00
RELEASES.txt	Minor adjustments to the 0.10 release notes.	2014-04-02 16:43:30 -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 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.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-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.