mirror of https://github.com/rust-lang/rust.git synced 2025-01-26 14:43:24 +00:00

Empowering everyone to build reliable and efficient software.

Go to file

bors bf89b68a37 auto merge of #11664 : bjz/rust/identities, r=alexcrichton `Zero` and `One` have precise definitions in mathematics as the identities of the `Add` and `Mul` operations respectively. As such, types that implement these identities are now also required to implement their respective operator traits. This should reduce their misuse whilst still enabling them to be used in generalized algebraic structures (not just numbers). Existing usages of `#[deriving(Zero)]` in client code could break under these new rules, but this is probably a sign that they should have been using something like `#[deriving(Default)]` in the first place. For more information regarding the mathematical definitions of the additive and multiplicative identities, see the following Wikipedia articles: - http://wikipedia.org/wiki/Additive_identity - http://wikipedia.org/wiki/Multiplicative_identity Note that for floating point numbers the laws specified in the doc comments of `Zero::zero` and `One::one` may not always hold. This is true however for many other traits currently implemented by floating point numbers. What traits floating point numbers should and should not implement is an open question that is beyond the scope of this pull request. The implementation of `std::num::pow` has been made more succinct and no longer requires `Clone`. The coverage of the associated unit test has also been increased to test for more combinations of bases, exponents, and expected results.		2014-01-20 10:16:30 -08:00
doc	auto merge of #11654 : korenchkin/rust/doc_guide-testing_format, r=cmr	2014-01-19 23:51:33 -08:00
man	remove the rusti command	2013-10-16 22:54:38 -04:00
mk	auto merge of #11619 : adridu59/rust/patch-md, r=cmr	2014-01-18 09:01:46 -08:00
src	auto merge of #11664 : bjz/rust/identities, r=alexcrichton	2014-01-20 10:16:30 -08:00
.gitattributes	drop the linenoise library	2013-10-16 22:57:51 -04:00
.gitignore	doc: build the docs for librustpkg	2014-01-11 19:13:59 -08: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 AUTHORS.txt	2014-01-06 15:01:34 -08:00
configure	Add a configure to disable libstd version injection	2014-01-15 08:22:16 -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	auto merge of #11590 : vadimcn/rust/llvm-tools, r=alexcrichton	2014-01-16 04:31:52 -08:00
README.md	Various READMEs and docs cleanup	2014-01-11 19:41:31 +01: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; 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 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.