Go to file

Alex Crichton 3f11f87382 Move task count bookeeping out of libstd For libgreen, bookeeping should not be global but rather on a per-pool basis. Inside libnative, it's known that there must be a global counter with a mutex/cvar. The benefit of taking this strategy is to remove this functionality from libstd to allow fine-grained control of it through libnative/libgreen. Notably, helper threads in libnative can manually decrement the global count so they don't count towards the global count of threads. Also, the shutdown process of all sched pools is now dependent on the number of tasks in the pool being 0 rather than this only being a hardcoded solution for the initial sched pool in libgreen. This involved adding a Local::try_take() method on the Local trait in order for the channel wakeup to work inside of libgreen. The channel send was happening from a SchedTask when there is no Task available in TLS, and now this is possible to work (remote wakeups are always possible, just a little slower).		2014-01-01 13:08:09 -08:00
doc	Update tutorial.md : rename pkgid to crate_id	2013-12-28 10:32:03 +01:00
man	remove the rusti command	2013-10-16 22:54:38 -04:00
mk	Add a compiler-docs target	2013-12-29 00:13:19 -05:00
src	Move task count bookeeping out of libstd	2014-01-01 13:08:09 -08:00
.gitattributes	drop the linenoise library	2013-10-16 22:57:51 -04:00
.gitignore	Remove many false positives from the ctags results	2013-12-20 01:59:01 +11:00
.gitmodules	auto merge of #11181 : luqmana/rust/up-llvm, r=alexcrichton	2013-12-29 21:51:56 -08:00
.mailmap
AUTHORS.txt
configure	llvm: Disable pthread on mingw	2013-12-18 09:48:58 +09: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	Test fixes and rebase problems	2013-12-24 19:59:53 -08:00
README.md
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.