2012-07-10 05:18:37 +00:00
|
|
|
|
# The Rust Programming Language
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2015-06-18 21:48:51 +00:00
|
|
|
|
Rust is a fast systems programming language that guarantees
|
|
|
|
|
memory safety and offers painless concurrency ([no data races]).
|
|
|
|
|
It does not employ a garbage collector and has minimal runtime overhead.
|
2015-05-15 05:43:40 +00:00
|
|
|
|
|
2015-06-17 20:13:37 +00:00
|
|
|
|
This repo contains the code for the compiler (`rustc`), as well
|
2015-05-15 05:43:40 +00:00
|
|
|
|
as standard libraries, tools and documentation for Rust.
|
2012-07-10 05:13:48 +00:00
|
|
|
|
|
2015-06-18 21:48:51 +00:00
|
|
|
|
[no data races]: http://blog.rust-lang.org/2015/04/10/Fearless-Concurrency.html
|
|
|
|
|
|
2013-07-18 23:27:43 +00:00
|
|
|
|
## Quick Start
|
2012-07-10 05:13:48 +00:00
|
|
|
|
|
2015-02-16 05:20:27 +00:00
|
|
|
|
Read ["Installing Rust"] from [The Book].
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2015-08-09 21:15:05 +00:00
|
|
|
|
["Installing Rust"]: https://doc.rust-lang.org/book/installing-rust.html
|
|
|
|
|
[The Book]: https://doc.rust-lang.org/book/index.html
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2014-04-02 23:59:39 +00:00
|
|
|
|
## Building from Source
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2014-01-11 14:19:38 +00:00
|
|
|
|
1. Make sure you have installed the dependencies:
|
2015-02-21 22:46:06 +00:00
|
|
|
|
|
|
|
|
|
* `g++` 4.7 or `clang++` 3.x
|
|
|
|
|
* `python` 2.6 or later (but not 3.x)
|
|
|
|
|
* GNU `make` 3.81 or later
|
|
|
|
|
* `curl`
|
|
|
|
|
* `git`
|
2015-02-13 17:26:44 +00:00
|
|
|
|
|
2015-02-18 21:46:20 +00:00
|
|
|
|
2. Clone the [source] with `git`:
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
```sh
|
|
|
|
|
$ git clone https://github.com/rust-lang/rust.git
|
|
|
|
|
$ cd rust
|
|
|
|
|
```
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2015-02-16 04:20:25 +00:00
|
|
|
|
[source]: https://github.com/rust-lang/rust
|
|
|
|
|
|
|
|
|
|
3. Build and install:
|
2014-01-11 14:19:38 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
```sh
|
|
|
|
|
$ ./configure
|
|
|
|
|
$ make && make install
|
|
|
|
|
```
|
2014-01-11 14:19:38 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00: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.
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
|
|
|
|
When complete, `make install` will place several programs into
|
2014-02-02 07:56:55 +00:00
|
|
|
|
`/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
|
2015-02-16 04:41:16 +00:00
|
|
|
|
API-documentation tool. This install does not include [Cargo],
|
|
|
|
|
Rust's package manager, which you may also want to build.
|
|
|
|
|
|
|
|
|
|
[Cargo]: https://github.com/rust-lang/cargo
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2014-06-27 00:07:44 +00:00
|
|
|
|
### Building on Windows
|
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
[MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows:
|
2014-06-27 00:07:44 +00:00
|
|
|
|
|
|
|
|
|
1. Grab the latest MSYS2 installer and go through the installer.
|
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
|
|
|
|
|
tools.
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
# Choose one based on platform:
|
|
|
|
|
$ pacman -S mingw-w64-i686-toolchain
|
|
|
|
|
$ pacman -S mingw-w64-x86_64-toolchain
|
2015-03-14 23:09:26 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
$ pacman -S base-devel
|
|
|
|
|
```
|
2014-06-27 00:07:44 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
|
2015-07-03 08:16:13 +00:00
|
|
|
|
MSYS2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
|
2015-01-12 21:00:03 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
4. Navigate to Rust's source code, configure and build it:
|
2014-06-27 00:07:44 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
```sh
|
|
|
|
|
$ ./configure
|
|
|
|
|
$ make && make install
|
|
|
|
|
```
|
2014-06-27 00:07:44 +00:00
|
|
|
|
|
2013-07-18 23:27:43 +00: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.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
|
Snapshot binaries are currently built and tested on several platforms:
|
2012-07-10 05:20:32 +00:00
|
|
|
|
|
2015-05-12 06:43:58 +00:00
|
|
|
|
| Platform \ Architecture | x86 | x86_64 |
|
|
|
|
|
|--------------------------------|-----|--------|
|
|
|
|
|
| Windows (7, 8, Server 2008 R2) | ✓ | ✓ |
|
|
|
|
|
| Linux (2.6.18 or later) | ✓ | ✓ |
|
|
|
|
|
| OSX (10.7 Lion or later) | ✓ | ✓ |
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2014-01-11 14:19:38 +00:00
|
|
|
|
You may find that other platforms work, but these are our officially
|
2012-10-11 00:56:38 +00:00
|
|
|
|
supported build environments that are most likely to work.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2014-01-11 14:19:38 +00:00
|
|
|
|
Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
|
2013-07-18 23:27:43 +00:00
|
|
|
|
swap, it will take a very long time to build.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2015-02-18 21:48:46 +00:00
|
|
|
|
There is more advice about hacking on Rust in [CONTRIBUTING.md].
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2015-02-18 21:48:46 +00:00
|
|
|
|
[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
## Getting Help
|
2014-08-22 18:04:35 +00:00
|
|
|
|
|
|
|
|
|
The Rust community congregates in a few places:
|
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
* [Stack Overflow] - Direct questions about using the language.
|
|
|
|
|
* [users.rust-lang.org] - General discussion and broader questions.
|
2015-01-29 23:49:00 +00:00
|
|
|
|
* [/r/rust] - News and general discussion.
|
2014-08-22 18:04:35 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
[Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
|
2014-08-22 18:04:35 +00:00
|
|
|
|
[/r/rust]: http://reddit.com/r/rust
|
2015-08-09 21:15:05 +00:00
|
|
|
|
[users.rust-lang.org]: https://users.rust-lang.org/
|
2015-02-13 17:26:44 +00:00
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2015-03-08 21:37:23 +00:00
|
|
|
|
To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
|
2014-08-22 18:04:35 +00:00
|
|
|
|
|
2015-02-16 04:58:06 +00:00
|
|
|
|
Rust has an [IRC] culture and most real-time collaboration happens in a
|
|
|
|
|
variety of channels on Mozilla's IRC network, irc.mozilla.org. The
|
|
|
|
|
most popular channel is [#rust], a venue for general discussion about
|
2015-02-21 22:46:06 +00:00
|
|
|
|
Rust, and a good place to ask for help.
|
2015-02-16 04:58:06 +00:00
|
|
|
|
|
|
|
|
|
[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
|
2015-02-18 21:46:20 +00:00
|
|
|
|
[#rust]: irc://irc.mozilla.org/rust
|
2015-02-16 04:58:06 +00:00
|
|
|
|
|
2012-07-10 05:13:48 +00:00
|
|
|
|
## License
|
|
|
|
|
|
2012-12-28 21:40:33 +00: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.
|
2012-07-10 05:13:48 +00:00
|
|
|
|
|
2015-03-08 21:37:23 +00:00
|
|
|
|
See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.
|