2012-07-10 05:18:37 +00:00
# The Rust Programming Language
2012-01-23 21:53:12 +00:00
2015-11-09 21:22:16 +00:00
This is the main source code repository for [Rust]. It contains the compiler, standard library,
and documentation.
2015-05-15 05:43:40 +00:00
2015-11-09 21:22:16 +00:00
[Rust]: https://www.rust-lang.org
2015-06-18 21:48:51 +00:00
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
2016-01-29 09:45:37 +00:00
["Installing Rust"]: https://doc.rust-lang.org/book/getting-started.html#installing-rust
2015-08-09 21:15:05 +00:00
[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
2016-04-30 21:21:18 +00:00
* `g++` 4.7 or later or `clang++` 3.x
2016-02-13 20:19:44 +00:00
* `python` 2.7 (but not 3.x)
2015-02-21 22:46:06 +00:00
* 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
2016-01-04 17:33:43 +00:00
There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
you need depends largely on what C/C++ libraries you want to interoperate with:
for interop with software produced by Visual Studio use the MSVC build of Rust;
for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
build.
#### MinGW
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
2015-08-28 07:46:23 +00:00
# Update package mirrors (may be needed if you have a fresh install of MSYS2)
2015-08-28 18:24:13 +00:00
$ pacman -Sy pacman-mirrors
2016-01-04 17:33:43 +00:00
```
2015-10-06 15:14:11 +00:00
2016-06-09 19:05:46 +00:00
Download [MinGW from
here](http://mingw-w64.org/doku.php/download/mingw-builds), and choose the
`version=4.9.x,threads=win32,exceptions=dwarf/seh` flavor when installing. Also, make sure to install to a path without spaces in it. After installing,
add its `bin` directory to your `PATH` . This is due to [#28260 ](https://github.com/rust-lang/rust/issues/28260 ), in the future,
installing from pacman should be just fine.
2015-03-14 23:09:26 +00:00
2016-06-09 19:05:46 +00:00
```sh
2015-10-20 08:02:19 +00:00
# Make git available in MSYS2 (if not already available on path)
$ pacman -S git
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.
2016-06-08 09:27:31 +00:00
(As of the latest version of MSYS2 you have to run `msys2_shell.cmd -mingw32`
or `msys2_shell.cmd -mingw64` from the command line instead)
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
```
2016-01-04 17:33:43 +00:00
#### MSVC
MSVC builds of Rust additionally require an installation of Visual Studio 2013
(or later) so `rustc` can use its linker. Make sure to check the “C++ tools”
option. In addition, `cmake` needs to be installed to build LLVM.
With these dependencies installed, the build takes two steps:
```sh
$ ./configure
$ make & & make install
```
2014-06-27 00:07:44 +00:00
2015-08-18 17:49:20 +00:00
## Building Documentation
If you’ d like to build the documentation, it’ s almost the same:
```sh
./configure
$ make docs
```
Building the documentation requires building the compiler, so the above
details will apply. Once you have the compiler built, you can
```sh
2015-10-20 08:02:19 +00:00
$ make docs NO_REBUILD=1
2015-08-18 17:49:20 +00:00
```
To make sure you don’ t re-build the compiler because you made a change
to some documentation.
The generated documentation will appear in a top-level `doc` directory,
created by the `make` rule.
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
2015-12-07 00:12:53 +00:00
Rust currently needs between 600MiB and 1.5GiB to build, depending on platform. 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
2016-03-31 02:07:53 +00:00
Rust. And a good place to ask for help would be [#rust-beginners].
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
2016-03-31 02:07:53 +00:00
[#rust-beginners]: irc://irc.mozilla.org/rust-beginners
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.