1 # The Rust Programming Language
3 This is the main source code repository for [Rust]. It contains the compiler, standard library,
6 [Rust]: https://www.rust-lang.org
10 Read ["Installing Rust"] from [The Book].
12 ["Installing Rust"]: https://doc.rust-lang.org/book/installing-rust.html
13 [The Book]: https://doc.rust-lang.org/book/index.html
15 ## Building from Source
17 1. Make sure you have installed the dependencies:
19 * `g++` 4.7 or `clang++` 3.x
20 * `python` 2.6 or later (but not 3.x)
21 * GNU `make` 3.81 or later
25 2. Clone the [source] with `git`:
28 $ git clone https://github.com/rust-lang/rust.git
32 [source]: https://github.com/rust-lang/rust
38 $ make && make install
41 > ***Note:*** You may need to use `sudo make install` if you do not
42 > normally have permission to modify the destination directory. The
43 > install locations can be adjusted by passing a `--prefix` argument
44 > to `configure`. Various other options are also supported – pass
45 > `--help` for more information on them.
47 When complete, `make install` will place several programs into
48 `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
49 API-documentation tool. This install does not include [Cargo],
50 Rust's package manager, which you may also want to build.
52 [Cargo]: https://github.com/rust-lang/cargo
54 ### Building on Windows
56 [MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows:
58 1. Grab the latest MSYS2 installer and go through the installer.
60 2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
64 # Update package mirrors (may be needed if you have a fresh install of MSYS2)
65 $ pacman -Sy pacman-mirrors
67 # Choose one based on platform:
68 # *** see the note below ***
69 $ pacman -S mingw-w64-i686-toolchain
70 $ pacman -S mingw-w64-x86_64-toolchain
72 # Make git available in MSYS2 (if not already available on path)
75 $ pacman -S base-devel
78 3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
79 MSYS2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
81 4. Navigate to Rust's source code, configure and build it:
85 $ make && make install
87 > ***Note:*** gcc versions >= 5 currently have issues building LLVM on Windows
88 > resulting in a segmentation fault when building Rust. In order to avoid this
89 > it may be necessary to obtain an earlier version of gcc such as 4.9.x.
90 > Msys's `pacman` will install the latest version, so for the time being it is
91 > recommended to skip gcc toolchain installation step above and use [Mingw-Builds]
92 > project's installer instead. Be sure to add gcc `bin` directory to the path
93 > before running `configure`.
94 > For more information on this see issue #28260.
96 [Mingw-Builds]: http://sourceforge.net/projects/mingw-w64/
98 ## Building Documentation
100 If you’d like to build the documentation, it’s almost the same:
107 Building the documentation requires building the compiler, so the above
108 details will apply. Once you have the compiler built, you can
111 $ make docs NO_REBUILD=1
114 To make sure you don’t re-build the compiler because you made a change
115 to some documentation.
117 The generated documentation will appear in a top-level `doc` directory,
118 created by the `make` rule.
122 Since the Rust compiler is written in Rust, it must be built by a
123 precompiled "snapshot" version of itself (made in an earlier state of
124 development). As such, source builds require a connection to the Internet, to
125 fetch snapshots, and an OS that can execute the available snapshot binaries.
127 Snapshot binaries are currently built and tested on several platforms:
129 | Platform \ Architecture | x86 | x86_64 |
130 |--------------------------------|-----|--------|
131 | Windows (7, 8, Server 2008 R2) | ✓ | ✓ |
132 | Linux (2.6.18 or later) | ✓ | ✓ |
133 | OSX (10.7 Lion or later) | ✓ | ✓ |
135 You may find that other platforms work, but these are our officially
136 supported build environments that are most likely to work.
138 Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
139 swap, it will take a very long time to build.
141 There is more advice about hacking on Rust in [CONTRIBUTING.md].
143 [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
147 The Rust community congregates in a few places:
149 * [Stack Overflow] - Direct questions about using the language.
150 * [users.rust-lang.org] - General discussion and broader questions.
151 * [/r/rust] - News and general discussion.
153 [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
154 [/r/rust]: http://reddit.com/r/rust
155 [users.rust-lang.org]: https://users.rust-lang.org/
159 To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
161 Rust has an [IRC] culture and most real-time collaboration happens in a
162 variety of channels on Mozilla's IRC network, irc.mozilla.org. The
163 most popular channel is [#rust], a venue for general discussion about
164 Rust, and a good place to ask for help.
166 [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
167 [#rust]: irc://irc.mozilla.org/rust
171 Rust is primarily distributed under the terms of both the MIT license
172 and the Apache License (Version 2.0), with portions covered by various
175 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.