Find a file
Alex Crichton 5bb204ffdb Add a Travis-CI configuration for the repo
Travis CI provides an easy-to-use continuous integration infrastructure for
github repos to use. Travis will automatically test all PRs which are opened
against the rust repository, informing PR owners of the test results.

I believe that this will be a very convenient piece of infrastructure as we'll
be able to reduce the load on bors quite a bit. In theory all PRs opened have
had the full test suite run against them, but unfortunately this is rarely the
case (I'm a prime suspect). Travis will be able to provide easy and relatively
quick (~30min) feedback for PRs. By ensuring fewer failures on bors, we can
hopefully feed more successful jobs to bors.

Overall, I expect this to be very helpful for new contributors as well as
regular contributors as it's another layer of tests being run which will
hopefully catch things sooner. One of the most convenient parts about using
Travis is that there's very little burden in terms of maintenance, and if things
go wrong we can easily turn travis completely off.

Note that this is *not* the metric by which a PR will be merged with. Using
travis will purely be another source for running tests, we will continue to gate
all PRs on bors.
2014-02-20 21:43:25 -08:00
man Consolidate codegen-related compiler flags 2014-02-10 00:50:39 -08:00
mk mk: Fix --llvm-root finding tools 2014-02-20 21:22:48 -08:00
src Add a Travis-CI configuration for the repo 2014-02-20 21:43:25 -08:00
.gitattributes drop the linenoise library 2013-10-16 22:57:51 -04:00
.gitignore Ignore /build even if it’s a symlink. 2014-02-16 12:41:41 +00:00
.gitmodules Build compiler-rt and link it to all crates, similarly to morestack. 2014-02-11 15:59:59 -08:00
.mailmap
.travis.yml Add a Travis-CI configuration for the repo 2014-02-20 21:43:25 -08:00
AUTHORS.txt Update extract-tests.py to use same test directives as rustdoc. 2014-01-28 14:52:36 -06:00
configure configure: Accept LLVM 3.5 for building rust 2014-02-20 21:22:47 -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 mk: Talk about make clean in the build help 2014-02-18 11:55:34 +01:00
README.md Remove rustpkg. 2014-02-02 03:08:56 -05:00
RELEASES.txt More 0.9 release notes 2014-01-06 14:52:16 -08:00

The Rust Programming Language

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

Quick Start

Windows

  1. Download and use the installer and MinGW.
  2. Read the tutorial.
  3. Enjoy!

Note: Windows users can read the detailed getting started notes on the wiki.

Linux / OS X

  1. 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
  2. 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, and rustdoc, the API-documentation tool. system.

  3. Read the tutorial.

  4. 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, 8, Server 2008 R2), x86 only
  • Linux (2.6.18 or later, various distributions), x86 and x86-64
  • OSX 10.7 (Lion) 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.

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