Go to file

bors 1f49e02d1d auto merge of #16909 : carols10cents/rust/docs-links, r=alexcrichton This has the primary advantage of not interfering with browser default behavior for links like being able to cmd/ctrl+click on a result to open the result in a new tab but leave the current page as-is (previous behavior both opened a new tab and changed the current tab's location to the result's). I've done my best to keep the rest of the behavior and the appearance the same-- the whole row still highlights, still has a hand cursor, still moves to the result page with a normal click, arrows+enter still work. If the result is on the current page, the search is simply hidden. The biggest difference in behavior is that people using tab to navigate through the links will have to hit tab twice for each row, since each cell has its own `a` tag.. I could fix this by switching to `div`s and `span`s instead of a table, but that's potentially more CSS finicky? The biggest difference in appearance is probably that all the text in the search results is Fira Sans now, instead of just the method name with the rest of the text in Source Serif Pro. I can put this appearance back, but it looks like all links anywhere on the page are Fira Sans. Only the name was in an `a` tag before, but the whole row was ACTING like a link, so I think this is actually more consistent. [I've pushed these changes to a gh-pages repo](https://carols10cents.github.io/rustdoc-playground/std/index.html?search=t) if you'd like to take a look at the effects; note that I also have my changes for PR #16735 there too so the search results will be sorted differently than on master.		2014-09-04 04:51:05 +00:00
man	rustc.1: fix typo	2014-07-16 08:01:59 +02:00
mk	auto merge of #16322 : michaelwoerister/rust/gdb-pretty, r=alexcrichton	2014-08-30 04:01:24 +00:00
src	auto merge of #16909 : carols10cents/rust/docs-links, r=alexcrichton	2014-09-04 04:51:05 +00:00
.gitattributes	webfonts: proper fix	2014-07-08 20:29:36 +02:00
.gitignore	gitignore: Add the autogenerated/downloaded unicode data files.	2014-08-03 17:32:53 +10:00
.gitmodules	add back jemalloc to the tree	2014-05-10 19:58:17 -04:00
.mailmap
.travis.yml	travis: Move from travis_wait to time-passes	2014-07-01 20:21:16 -07:00
AUTHORS.txt	Updated release notes for 0.11.0	2014-06-30 07:25:58 -07:00
configure	debuginfo: Emit different autotest debugger scripts depending on GDB version.	2014-08-27 15:19:14 +02:00
CONTRIBUTING.md	Make small doc contributions less onerous/intimidating	2014-08-08 19:36:32 -04:00
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in	Shuffle around check-lexer conditions	2014-07-21 18:38:40 -07:00
README.md	configure: Recognize i686 build on msys2	2014-08-23 01:47:37 +09:00
RELEASES.txt	Update RELEASES.txt	2014-07-05 00:22:59 -04:00

README.md

The Rust Programming Language

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

Quick Start

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

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

Building from Source

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
Download and build Rust:

You can either download a tarball or build directly from the repo.

To build from the tarball do:
```
 $ curl -O https://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/rust-lang/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.
Read the tutorial.
Enjoy!

Building on Windows

To easily build on windows we can use MSYS2:

Grab the latest MSYS2 installer and go through the installer.
Now from the MSYS2 terminal we want to install the mingw64 toolchain and the other tools we need.
```
 $ pacman -S mingw-w64-i686-toolchain
 $ pacman -S base-devel
```
With that now start mingw32_shell.bat from where you installed MSYS2 (i.e. C:\msys).
From there just navigate to where you have Rust's source code, configure and build it:
```
 $ ./configure
 $ make && make install
```

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.