16a6ebd1f6
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.
122 lines
4.0 KiB
Markdown
122 lines
4.0 KiB
Markdown
# 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)
|
|
* `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 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://sourceforge.net/projects/msys2/):
|
|
|
|
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.
|
|
|
|
$ pacman -S mingw-w64-i686-toolchain
|
|
$ pacman -S base-devel
|
|
|
|
3. With that now start `mingw32_shell.bat` from where you installed MSYS2 (i.e. `C:\msys`).
|
|
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.
|