rust/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][installer] for your platform.
2. Read [The Rust Programming Language][trpl].
3. Enjoy!

> ***Note:*** Windows users can read the detailed
> [using Rust on Windows][win-wiki] notes on the wiki.

[installer]: http://www.rust-lang.org/install.html
[trpl]: http://doc.rust-lang.org/book/index.html
[win-wiki]: https://github.com/rust-lang/rust/wiki/Using-Rust-on-Windows

## 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)
    * 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 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.
3. Read [The Rust Programming Language][trpl].
4. Enjoy!

### Building on Windows

To easily build on windows we can use [MSYS2](http://msys2.github.io/):

1. Grab the latest MSYS2 installer and go through the installer.
2. Now from the MSYS2 terminal we want to install the mingw64 toolchain and the other
   tools we need.

```bash
# choose one based on platform
$ pacman -S mingw-w64-i686-toolchain
$ pacman -S mingw-w64-x86_64-toolchain

$ pacman -S base-devel
```

3. With that now start `mingw32_shell.bat` or `mingw64_shell.bat`
   from where you installed MSYS2 (i.e. `C:\msys`). Which one you
   choose depends on if you want 32 or 64 bit Rust.
4. From there just navigate to where you have Rust's source code, configure and build it:

        $ ./configure
        $ make && make install

[repo]: https://github.com/rust-lang/rust
[tarball]: https://static.rust-lang.org/dist/rust-nightly.tar.gz
[trpl]: http://doc.rust-lang.org/book/index.html

## 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].

[wiki]: https://github.com/rust-lang/rust/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.

[StackOverflow]: http://stackoverflow.com/questions/tagged/rust
[/r/rust]: http://reddit.com/r/rust
[discuss.rust-lang.org]: http://discuss.rust-lang.org/

## 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.
Capitalize 'Rust Programming Language' in README.md 2012-07-10 13:18:37 +08:00			`# The Rust Programming Language`
Add an INSTALL.txt and make it part of the source distribution 2012-01-24 05:53:12 +08:00
Merge README.txt and INSTALL.txt into README.md 2012-07-10 13:13:48 +08:00			`This is a compiler for Rust, including standard libraries, tools and`
			`documentation.`

Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00			`## Quick Start`
Merge README.txt and INSTALL.txt into README.md 2012-07-10 13:13:48 +08:00
Update README.md Fix typo 2014-04-05 00:22:55 +08:00			`1. Download a [binary installer][installer] for your platform.`
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section. 2014-12-02 22:20:48 +08:00			`2. Read [The Rust Programming Language][trpl].`
Tweak the installation instructions in the README Update the instructions to reflect that we have binary installers for all supported platforms, and move the building from source directions into a dedicated "Building from Source" directory. 2014-04-03 07:59:39 +08:00			`3. Enjoy!`
Add an INSTALL.txt and make it part of the source distribution 2012-01-24 05:53:12 +08:00
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00			`> *Note:* Windows users can read the detailed`
readme: Link 'Using' wiki page instead of 'Getting started'. The Windows-specific instruction under 'Quick Start' linked the wiki article on getting started developing Rust itself, but the quick start is just about obtaining a working Rust installation. The actual wiki page with Windows-specific instructions was difficult to find. 2014-10-09 06:32:22 +08:00			`> [using Rust on Windows][win-wiki] notes on the wiki.`
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00
Tweak the installation instructions in the README Update the instructions to reflect that we have binary installers for all supported platforms, and move the building from source directions into a dedicated "Building from Source" directory. 2014-04-03 07:59:39 +08:00			`[installer]: http://www.rust-lang.org/install.html`
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section. 2014-12-02 22:20:48 +08:00			`[trpl]: http://doc.rust-lang.org/book/index.html`
Update repo location 2014-06-17 07:07:34 +08:00			`[win-wiki]: https://github.com/rust-lang/rust/wiki/Using-Rust-on-Windows`
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00
Tweak the installation instructions in the README Update the instructions to reflect that we have binary installers for all supported platforms, and move the building from source directions into a dedicated "Building from Source" directory. 2014-04-03 07:59:39 +08:00			`## Building from Source`
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00			`1. Make sure you have installed the dependencies:`
Update minimum g++ version in documentation Version changed due to a newer requirement in LLVM. 2014-05-05 10:03:00 +08:00			* `g++` 4.7 or `clang++` 3.x
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00			* `python` 2.6 or later (but not 3.x)
			* GNU `make` 3.81 or later
			* `curl`
Add git to README.md dependency list because configure requires it 2014-04-19 02:50:31 +08:00			* `git`
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00			`2. Download and build Rust:`

Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00			`You can either download a [tarball] or build directly from the [repo].`
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00			`To build from the [tarball] do:`
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00
Update docs to use HTTPS for static.rust-lang.org addresses cc #16123 2014-08-12 03:30:37 +08:00			`$ curl -O https://static.rust-lang.org/dist/rust-nightly.tar.gz`
Bump version to 0.11-pre This also changes some of the download links in the documentation to 'nightly'. 2014-04-04 07:28:46 +08:00			`$ tar -xzf rust-nightly.tar.gz`
			`$ cd rust-nightly`
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00			`Or to build from the [repo] do:`

Update repo location 2014-06-17 07:07:34 +08:00			`$ git clone https://github.com/rust-lang/rust.git`
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00			`$ cd rust`

			`Now that you have Rust's source code, you can configure and build it:`
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00			`$ ./configure`
			`$ make && make install`
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00
			> *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.
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00
			When complete, `make install` will place several programs into
Remove rustpkg. I'm sorry :'( Closes #11859 2014-02-02 15:56:55 +08:00			`/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
			`API-documentation tool.`
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section. 2014-12-02 22:20:48 +08:00			`3. Read [The Rust Programming Language][trpl].`
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00			`4. Enjoy!`

README: Add instructions for building on windows. 2014-06-27 08:07:44 +08:00			`### Building on Windows`

Link to a better place for msys2 This is much more helpful. 2015-01-13 04:56:16 +08:00			`To easily build on windows we can use [MSYS2](http://msys2.github.io/):`
README: Add instructions for building on windows. 2014-06-27 08:07:44 +08:00
			`1. Grab the latest MSYS2 installer and go through the installer.`
			`2. Now from the MSYS2 terminal we want to install the mingw64 toolchain and the other`
			`tools we need.`

Add notes about 32 vs 64 bit Windows 2015-01-13 05:00:03 +08:00			```bash
			`# choose one based on platform`
			`$ pacman -S mingw-w64-i686-toolchain`
			`$ pacman -S mingw-w64-x86_64-toolchain`
README: Add instructions for building on windows. 2014-06-27 08:07:44 +08:00
Add notes about 32 vs 64 bit Windows 2015-01-13 05:00:03 +08:00			`$ pacman -S base-devel`
			```

			3. With that now start `mingw32_shell.bat` or `mingw64_shell.bat`
			from where you installed MSYS2 (i.e. `C:\msys`). Which one you
			`choose depends on if you want 32 or 64 bit Rust.`
README: Add instructions for building on windows. 2014-06-27 08:07:44 +08:00			`4. From there just navigate to where you have Rust's source code, configure and build it:`

configure: Recognize i686 build on msys2 2014-08-23 00:45:15 +08:00			`$ ./configure`
README: Add instructions for building on windows. 2014-06-27 08:07:44 +08:00			`$ make && make install`

Update repo location 2014-06-17 07:07:34 +08:00			`[repo]: https://github.com/rust-lang/rust`
Update docs to use HTTPS for static.rust-lang.org addresses cc #16123 2014-08-12 03:30:37 +08:00			`[tarball]: https://static.rust-lang.org/dist/rust-nightly.tar.gz`
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section. 2014-12-02 22:20:48 +08:00			`[trpl]: http://doc.rust-lang.org/book/index.html`
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00
			`## 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.`
Add an INSTALL.txt and make it part of the source distribution 2012-01-24 05:53:12 +08:00
Copy README install instructions from tutorial 2012-10-11 08:56:38 +08:00			`Snapshot binaries are currently built and tested on several platforms:`
Use correct markdown in README.md 2012-07-10 13:20:32 +08:00
Update README.md Added 64-bit Windows support to the list of platforms. Support for 64-bit Windows was added in Rust 0.12.0. See https://mail.mozilla.org/pipermail/rust-dev/2014-October/011267.html for the release notes. 2014-10-10 12:41:30 +08:00			`* Windows (7, 8, Server 2008 R2), x86 and x86-64 (64-bit support added in Rust 0.12.0)`
mark the minimum supported Linux kernel version This is just taken from the binary itself. It would be nice to mark the minimum glibc version too, and the corresponding RHEL/CentOS version. 2014-01-31 22:58:00 +08:00			`* Linux (2.6.18 or later, various distributions), x86 and x86-64`
bump minimum supported OS X version to 10.7 Closes #11927 Closes #10842 Closes #2024 2014-01-31 22:50:44 +08:00			`* OSX 10.7 (Lion) or greater, x86 and x86-64`
Add an INSTALL.txt and make it part of the source distribution 2012-01-24 05:53:12 +08:00
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00			`You may find that other platforms work, but these are our officially`
Copy README install instructions from tutorial 2012-10-11 08:56:38 +08:00			`supported build environments that are most likely to work.`
Add an INSTALL.txt and make it part of the source distribution 2012-01-24 05:53:12 +08:00
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00			`Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits`
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-19 07:27:43 +08:00			`swap, it will take a very long time to build.`
Add an INSTALL.txt and make it part of the source distribution 2012-01-24 05:53:12 +08:00
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 22:19:38 +08:00			`There is a lot more documentation in the [wiki].`
Add an INSTALL.txt and make it part of the source distribution 2012-01-24 05:53:12 +08:00
Update repo location 2014-06-17 07:07:34 +08:00			`[wiki]: https://github.com/rust-lang/rust/wiki`
Add an INSTALL.txt and make it part of the source distribution 2012-01-24 05:53:12 +08:00
Add links to forums in README.md, including discuss.rust-lang.org 2014-08-23 02:04:35 +08:00			`## 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.`

			`[StackOverflow]: http://stackoverflow.com/questions/tagged/rust`
			`[/r/rust]: http://reddit.com/r/rust`
			`[discuss.rust-lang.org]: http://discuss.rust-lang.org/`

Merge README.txt and INSTALL.txt into README.md 2012-07-10 13:13:48 +08:00			`## License`

Wrap lines 2012-12-29 05:40:33 +08:00			`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.`
Merge README.txt and INSTALL.txt into README.md 2012-07-10 13:13:48 +08:00
Wrap lines 2012-12-29 05:40:33 +08:00			`See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.`