OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
28,726 Commits 1 Branch 0 Tags 636 MiB
Rust 97.9%
Python 0.5%
JavaScript 0.4%
C++ 0.3%
Shell 0.3%
Other 0.4%
e3050ffa52
Go to file
Zooko Wilcox-O'Hearn e3050ffa52 Optimize out exhortations about being careful. 
Yes, it is important to be careful, but repeated emphasis about it is probably
not helpful — it starts to sound like you came for a tutorial but found a
finger-wagging lecture.

Even after I removed a few of these comments, there are still several left in
the text. That's probably fine! A couple of mentions of how this is dangerous
and you ought to be careful may be a good reminder to the reader.

After making the edits, I reflowed the paragraphs that I had touched, using
emacs's "M-x fill-paragraph", with fill-column equal to 70.
2014-06-25 01:25:10 +00:00
man auto merge of #13557 : FlaPer87/rust/ls-behind-z, r=brson 2014-04-17 01:31:27 -07:00
mk make sure jemalloc valgrind support is enabled 2014-05-11 20:05:22 -04:00
src Optimize out exhortations about being careful. 2014-06-25 01:25:10 +00:00
.gitattributes make sure jemalloc valgrind support is enabled 2014-05-11 20:05:22 -04:00
.gitignore Add /dist/ to .gitignore 2014-03-09 14:17:27 -07:00
.gitmodules add back jemalloc to the tree 2014-05-10 19:58:17 -04:00
.mailmap
.travis.yml Let travis check docs for stage1 2014-03-20 10:20:08 +01:00
AUTHORS.txt Add Richo Healey to contributors 2014-05-05 20:49:50 -07:00
configure add back jemalloc to the tree 2014-05-10 19:58:17 -04:00
CONTRIBUTING.md Updated CONTRIBUTING.md for 2014 2014-05-05 15:46:10 -05:00
COPYRIGHT Update some copyright dates 2014-01-08 18:04:43 -08:00
LICENSE-APACHE
LICENSE-MIT Change the licence holder to The Rust Project Developers 2014-05-03 23:59:24 +02:00
Makefile.in auto merge of #13142 : alexcrichton/rust/issue-13118, r=brson 2014-03-27 17:11:58 -07:00
README.md Update minimum g++ version in documentation 2014-05-05 03:03:00 +01:00
RELEASES.txt Fix a/an typos 2014-05-01 20:02:11 -05:00

README.md

The Rust Programming Language

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

Quick Start

  1. Download a binary installer for your platform.
  2. Read the tutorial.
  3. Enjoy!

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

Building from Source

  1. Make sure you have installed the dependencies:

    • g++ 4.7 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
    • git

  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-nightly.tar.gz
 $ tar -xzf rust-nightly.tar.gz
 $ cd rust-nightly

    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.