Go to file

Alex Crichton 01ce6efd85 libc: Prepare for movement to crates.io This commit prepares the liblibc library to be moved to crates.io. Unlike the log, serialize, term, etc crates, the source for this crate will not be duplicated out-of-tree. Instead a new rust-lang/libc repository will be created with a submodule to this repository and it will use the source directly. In order to compile within the stable ecosystem of Rust, this crate cannot link to libcore, and it also needs some tweaks for the other attributes that it has. As a result this commit tweaks the source of the crate to link to libcore when built in tree but link to libstd when built via cargo. Note that the rust-lang/libc crate isn't quite prepared just yet, there's a Cargo bug or two that I'd like to iron out before publishing it. This is simply preparing the in-tree source.		2015-01-07 00:43:49 -08:00
man	Man page/--help dialog fix	2015-01-03 11:34:01 -08:00
mk	rollup merge of #20584 : brson/versioning	2015-01-05 18:42:08 -08:00
src	libc: Prepare for movement to crates.io	2015-01-07 00:43:49 -08:00
.gitattributes
.gitignore
.gitmodules
.mailmap
.travis.yml	Allow travis to use newer-faster infrastructure for building. http://blog.travis-ci.com/2014-12-17-faster-builds-with-container-based-infrastructure/	2015-01-01 02:00:29 -05:00
AUTHORS.txt
configure	Initial version of AArch64 support.	2015-01-03 15:16:10 +00:00
CONTRIBUTING.md	Put links to discuss.rust-lang.org and #rust-internals in CONTRIBUTING.md	2015-01-02 15:42:38 -08:00
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in
README.md
RELEASES.md

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 guide.
Enjoy!

Note: Windows users can read the detailed using Rust on Windows 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 guide.
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 and x86-64 (64-bit support added in Rust 0.12.0)
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.

Getting help and getting involved

The Rust community congregates in a few places:

StackOverflow - Get help here.
/r/rust - General discussion.
discuss.rust-lang.org - For development of the Rust language itself.

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.