Go to file

Alex Crichton 9c1851019f Remove all blocking std::os blocking functions This commit moves all thread-blocking I/O functions from the std::os module. Their replacements can be found in either std::rt::io::file or in a hidden "old_os" module inside of native::file. I didn't want to outright delete these functions because they have a lot of special casing learned over time for each OS/platform, and I imagine that these will someday get integrated into a blocking implementation of IoFactory. For now, they're moved to a private module to prevent bitrot and still have tests to ensure that they work. I've also expanded the extensions to a few more methods defined on Path, most of which were previously defined in std::os but now have non-thread-blocking implementations as part of using the current IoFactory. The api of io::file is in flux, but I plan on changing it in the next commit as well. Closes #10057		2013-11-03 15:15:42 -08:00
doc	auto merge of #9740 : alexcrichton/rust/concat, r=cmr	2013-10-31 17:51:26 -07:00
man	remove the rusti command	2013-10-16 22:54:38 -04:00
mk	Remove all blocking std::os blocking functions	2013-11-03 15:15:42 -08:00
src	Remove all blocking std::os blocking functions	2013-11-03 15:15:42 -08:00
.gitattributes	drop the linenoise library	2013-10-16 22:57:51 -04:00
.gitignore	doc: tidy and cleanup CSS deps, add tutorial PDF generation	2013-10-21 04:12:12 +02:00
.gitmodules	Point gyp submodule toward github	2013-10-25 20:23:53 -07:00
.mailmap
AUTHORS.txt	Update AUTHORS.txt	2013-09-24 16:26:27 -07:00
configure	auto merge of #10222 : nibrahim/rust/docfix, r=brson	2013-11-01 20:46:18 -07:00
CONTRIBUTING.md	syntax: Add the Bug Report HOWTO URL to the ICE message	2013-10-21 12:11:24 -07:00
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in	Rename files to match current recommendations.	2013-11-03 23:49:01 +11:00
README.md	Update version numbers to 0.8	2013-09-21 16:25:08 -07:00
RELEASES.txt	remove the rusti command	2013-10-16 22:54:38 -04: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.
Read the tutorial.
Enjoy!

Note: Windows users should read the detailed getting started notes on the wiki. Even when using the binary installer the Windows build requires a MinGW installation, the precise details of which are not discussed here.

Linux / OS X

Install the prerequisites (if not already installed)
- 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.8.tar.gz
 $ tar -xzf rust-0.8.tar.gz
 $ cd rust-0.8
```
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
```
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; rustdoc, the API-documentation tool, and rustpkg, the Rust package manager and build 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, Server 2008 R2), x86 only
Linux (various distributions), x86 and x86-64
OSX 10.6 ("Snow Leopard") or greater, x86 and x86-64

You may find that other platforms work, but these are our "tier 1" supported build environments that are most likely to work.

Rust currently needs about 1.8G of RAM to build without swapping; if it hits swap, it will take a very long time to build.

There is lots 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.