Go to file
Felix S. Klock II 5b10f4e117 Miscellaneous documentation additions.
Added notes explaining how [expr, ..expr] form is used, targeted at
individuals like me who thought it was more general and handled
dynamic repeat expressions.  (I left a TODO for this section in a
comment, but perhaps that is bad form for the manual...)

Added example of `do` syntax with a function of arity > 1; yes, one
should be able to derive this from the text above it, but it is still
a useful detail to compare and contrast against the arity == 1 case.

Added example of using for expression over a uint range, since someone
who is most used to write `for(int i; i < lim; i++) { ... }` will
likely want to know how to translate that form (regardless of whether
it happens to be good style or not for their use-case).

Added note about the semi-strange meaning of "fixed size" of vectors
in the vector type section.
2013-03-26 14:18:48 +01:00
doc Miscellaneous documentation additions. 2013-03-26 14:18:48 +01:00
man Update manpage based on current usage message 2013-02-15 01:29:14 +01:00
mk Merge remote-tracking branch 'brson/rt' 2013-03-25 12:28:54 -07:00
src auto merge of #5542 : catamorphism/rust/issue-4983, r=catamorphism 2013-03-26 04:42:57 -07:00
.gitignore .settings/ added in .gitignore 2012-10-24 18:36:40 +03:00
.gitmodules Update uv submodule 2013-03-06 17:44:22 -08:00
AUTHORS.txt Add Kang Seonghoon to AUTHORS 2013-02-25 18:46:36 -08:00
configure auto merge of #5540 : dbaupp/rust/configure-pandoc-version, r=brson 2013-03-26 03:31:03 -07:00
CONTRIBUTING.md Contributing.md: remove spurious verb 2013-03-01 22:46:00 +01:00
COPYRIGHT Update license, add license boilerplate to most files. Remainder will follow. 2012-12-03 17:12:14 -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 license, add license boilerplate to most files. Remainder will follow. 2012-12-03 17:12:14 -08:00
Makefile.in core: Add rt::io and start sketching the API 2013-03-18 16:59:37 -07:00
README.md Rename cargo to rustpkg and start over fresh 2013-02-15 18:04:10 -08:00
RELEASES.txt RELEASES.txt: wrong tick-mark 2013-03-25 15:53:02 -07:00

The Rust Programming Language

This is a compiler for Rust, including standard libraries, tools and documentation.

Installation

The Rust compiler currently must be built from a tarball, unless you are on Windows, in which case using the installer is recommended.

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.

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.

To build from source you will also need the following prerequisite packages:

  • 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

Assuming you're on a relatively modern *nix system and have met the prerequisites, something along these lines should work.

$ curl -O http://static.rust-lang.org/dist/rust-0.5.tar.gz
$ tar -xzf rust-0.5.tar.gz
$ cd rust-0.5
$ ./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.

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.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.

More help

The tutorial is a good starting point.