mirror of https://github.com/rust-lang/rust.git synced 2025-01-10 06:47:34 +00:00

Empowering everyone to build reliable and efficient software.

Go to file

bors 52ba3b6414 auto merge of #11611 : SiegeLord/rust/exp_printing, r=alexcrichton Fixes #6593 Currently, Rust provides no way to print very large or very small floating point values which come up routinely in scientific and modeling work. The classical solution to this is to use the scientific/exponential notation, which not-coincidentally, corresponds to how floating point values are encoded in memory. Given this, there are two solutions to the problem. One is what, as far as I understand it, Python does. I.e. for floating point numbers in a certain range it does what we do today with the `'f'` formatting flag, otherwise it switches to exponential notation. The other way is to provide a set of formatting flags to explicitly choose the exponential notation, like it is done in C. I've chosen the second way as I think its important to provide that kind of control to the user. This pull request changes the `std::num::strconv::float_to_str_common` function to optionally format floating point numbers using the exponential (scientific) notation. The base of the significant can be varied between 2 and 25, while the base of the exponent can be 2 or 10. Additionally this adds two new formatting specifiers to `format!` and friends: `'e'` and `'E'` which switch between outputs like `1.0e5` and `1.0E5`. Mostly parroting C stdlib in this sense, although I wasn't going for an exact output match.		2014-01-22 22:01:40 -08:00
doc	Typo in module tutorial	2014-01-22 16:03:00 -05: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 #11611 : SiegeLord/rust/exp_printing, r=alexcrichton	2014-01-22 22:01:40 -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
LICENSE-MIT	Update some copyright dates	2014-01-08 18:04:43 -08:00
Makefile.in	Remove no-debug-borrows from the makefiles	2014-01-21 10:02:48 -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.