]>
Commit | Line | Data |
---|---|---|
223e47cc LB |
1 | # The Rust Programming Language |
2 | ||
3157f602 XL |
3 | This is the main source code repository for [Rust]. It contains the compiler, |
4 | standard library, and documentation. | |
62682a34 | 5 | |
92a42be0 | 6 | [Rust]: https://www.rust-lang.org |
223e47cc | 7 | |
1a4d82fc | 8 | ## Quick Start |
223e47cc | 9 | |
85aaf69f | 10 | Read ["Installing Rust"] from [The Book]. |
223e47cc | 11 | |
7453a54e | 12 | ["Installing Rust"]: https://doc.rust-lang.org/book/getting-started.html#installing-rust |
e9174d1e | 13 | [The Book]: https://doc.rust-lang.org/book/index.html |
223e47cc | 14 | |
1a4d82fc | 15 | ## Building from Source |
223e47cc | 16 | |
1a4d82fc | 17 | 1. Make sure you have installed the dependencies: |
c34b1796 | 18 | |
a7813a04 | 19 | * `g++` 4.7 or later or `clang++` 3.x |
7453a54e | 20 | * `python` 2.7 (but not 3.x) |
c34b1796 | 21 | * GNU `make` 3.81 or later |
9e0c209e | 22 | * `cmake` 3.4.3 or later |
c34b1796 AL |
23 | * `curl` |
24 | * `git` | |
1a4d82fc | 25 | |
85aaf69f | 26 | 2. Clone the [source] with `git`: |
1a4d82fc | 27 | |
c34b1796 AL |
28 | ```sh |
29 | $ git clone https://github.com/rust-lang/rust.git | |
30 | $ cd rust | |
31 | ``` | |
1a4d82fc | 32 | |
85aaf69f SL |
33 | [source]: https://github.com/rust-lang/rust |
34 | ||
35 | 3. Build and install: | |
223e47cc | 36 | |
c34b1796 AL |
37 | ```sh |
38 | $ ./configure | |
476ff2be | 39 | $ make && sudo make install |
c34b1796 | 40 | ``` |
223e47cc | 41 | |
476ff2be SL |
42 | > ***Note:*** Install locations can be adjusted by passing a `--prefix` |
43 | > argument to `configure`. Various other options are also supported – pass | |
c34b1796 | 44 | > `--help` for more information on them. |
223e47cc | 45 | |
476ff2be | 46 | When complete, `sudo make install` will place several programs into |
1a4d82fc | 47 | `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the |
85aaf69f SL |
48 | API-documentation tool. This install does not include [Cargo], |
49 | Rust's package manager, which you may also want to build. | |
50 | ||
51 | [Cargo]: https://github.com/rust-lang/cargo | |
223e47cc | 52 | |
1a4d82fc | 53 | ### Building on Windows |
223e47cc | 54 | |
9cc50fc6 SL |
55 | There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by |
56 | Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust | |
57 | you need depends largely on what C/C++ libraries you want to interoperate with: | |
58 | for interop with software produced by Visual Studio use the MSVC build of Rust; | |
59 | for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU | |
60 | build. | |
61 | ||
62 | ||
63 | #### MinGW | |
64 | ||
3157f602 | 65 | [MSYS2][msys2] can be used to easily build Rust on Windows: |
223e47cc | 66 | |
5bcae85e | 67 | [msys2]: https://msys2.github.io/ |
223e47cc | 68 | |
3157f602 XL |
69 | 1. Grab the latest [MSYS2 installer][msys2] and go through the installer. |
70 | ||
71 | 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed | |
72 | MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit | |
73 | Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd | |
74 | -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead) | |
75 | ||
76 | 3. From this terminal, install the required tools: | |
c34b1796 AL |
77 | |
78 | ```sh | |
e9174d1e SL |
79 | # Update package mirrors (may be needed if you have a fresh install of MSYS2) |
80 | $ pacman -Sy pacman-mirrors | |
b039eaaf | 81 | |
3157f602 XL |
82 | # Install build tools needed for Rust. If you're building a 32-bit compiler, |
83 | # then replace "x86_64" below with "i686". If you've already got git, python, | |
84 | # or CMake installed and in PATH you can remove them from this list. Note | |
85 | # that it is important that the `python2` and `cmake` packages **not** used. | |
86 | # The build has historically been known to fail with these packages. | |
87 | $ pacman -S git \ | |
88 | make \ | |
89 | diffutils \ | |
c30ab7b3 | 90 | tar \ |
3157f602 XL |
91 | mingw-w64-x86_64-python2 \ |
92 | mingw-w64-x86_64-cmake \ | |
93 | mingw-w64-x86_64-gcc | |
c34b1796 | 94 | ``` |
223e47cc | 95 | |
3157f602 | 96 | 4. Navigate to Rust's source code (or clone it), then configure and build it: |
1a4d82fc | 97 | |
c34b1796 AL |
98 | ```sh |
99 | $ ./configure | |
100 | $ make && make install | |
101 | ``` | |
b039eaaf | 102 | |
9cc50fc6 SL |
103 | #### MSVC |
104 | ||
105 | MSVC builds of Rust additionally require an installation of Visual Studio 2013 | |
106 | (or later) so `rustc` can use its linker. Make sure to check the “C++ tools” | |
5bcae85e | 107 | option. |
9cc50fc6 | 108 | |
476ff2be SL |
109 | With these dependencies installed, you can build the compiler in a `cmd.exe` |
110 | shell with: | |
9cc50fc6 SL |
111 | |
112 | ```sh | |
476ff2be | 113 | > python x.py build |
9cc50fc6 | 114 | ``` |
1a4d82fc | 115 | |
476ff2be | 116 | If you're running inside of an msys shell, however, you can run: |
3157f602 | 117 | |
476ff2be SL |
118 | ```sh |
119 | $ ./configure --build=x86_64-pc-windows-msvc | |
120 | $ make && make install | |
5bcae85e SL |
121 | ``` |
122 | ||
476ff2be SL |
123 | Currently building Rust only works with some known versions of Visual Studio. If |
124 | you have a more recent version installed the build system doesn't understand | |
5bcae85e SL |
125 | then you may need to force rustbuild to use an older version. This can be done |
126 | by manually calling the appropriate vcvars file before running the bootstrap. | |
127 | ||
128 | ``` | |
3157f602 | 129 | CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat" |
c30ab7b3 | 130 | python x.py build |
3157f602 XL |
131 | ``` |
132 | ||
e9174d1e SL |
133 | ## Building Documentation |
134 | ||
135 | If you’d like to build the documentation, it’s almost the same: | |
136 | ||
137 | ```sh | |
3157f602 | 138 | $ ./configure |
e9174d1e SL |
139 | $ make docs |
140 | ``` | |
141 | ||
e9174d1e SL |
142 | The generated documentation will appear in a top-level `doc` directory, |
143 | created by the `make` rule. | |
144 | ||
1a4d82fc JJ |
145 | ## Notes |
146 | ||
147 | Since the Rust compiler is written in Rust, it must be built by a | |
148 | precompiled "snapshot" version of itself (made in an earlier state of | |
149 | development). As such, source builds require a connection to the Internet, to | |
150 | fetch snapshots, and an OS that can execute the available snapshot binaries. | |
151 | ||
152 | Snapshot binaries are currently built and tested on several platforms: | |
223e47cc | 153 | |
9e0c209e | 154 | | Platform / Architecture | x86 | x86_64 | |
d9579d0f AL |
155 | |--------------------------------|-----|--------| |
156 | | Windows (7, 8, Server 2008 R2) | ✓ | ✓ | | |
157 | | Linux (2.6.18 or later) | ✓ | ✓ | | |
158 | | OSX (10.7 Lion or later) | ✓ | ✓ | | |
1a4d82fc JJ |
159 | |
160 | You may find that other platforms work, but these are our officially | |
161 | supported build environments that are most likely to work. | |
162 | ||
3157f602 XL |
163 | Rust currently needs between 600MiB and 1.5GiB to build, depending on platform. |
164 | If it hits swap, it will take a very long time to build. | |
1a4d82fc | 165 | |
85aaf69f | 166 | There is more advice about hacking on Rust in [CONTRIBUTING.md]. |
1a4d82fc | 167 | |
85aaf69f | 168 | [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md |
1a4d82fc | 169 | |
c34b1796 | 170 | ## Getting Help |
1a4d82fc JJ |
171 | |
172 | The Rust community congregates in a few places: | |
173 | ||
c34b1796 AL |
174 | * [Stack Overflow] - Direct questions about using the language. |
175 | * [users.rust-lang.org] - General discussion and broader questions. | |
85aaf69f | 176 | * [/r/rust] - News and general discussion. |
1a4d82fc | 177 | |
c34b1796 | 178 | [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust |
1a4d82fc | 179 | [/r/rust]: http://reddit.com/r/rust |
e9174d1e | 180 | [users.rust-lang.org]: https://users.rust-lang.org/ |
85aaf69f SL |
181 | |
182 | ## Contributing | |
183 | ||
c34b1796 | 184 | To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md). |
85aaf69f SL |
185 | |
186 | Rust has an [IRC] culture and most real-time collaboration happens in a | |
187 | variety of channels on Mozilla's IRC network, irc.mozilla.org. The | |
188 | most popular channel is [#rust], a venue for general discussion about | |
54a0048b | 189 | Rust. And a good place to ask for help would be [#rust-beginners]. |
85aaf69f SL |
190 | |
191 | [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat | |
192 | [#rust]: irc://irc.mozilla.org/rust | |
54a0048b | 193 | [#rust-beginners]: irc://irc.mozilla.org/rust-beginners |
223e47cc LB |
194 | |
195 | ## License | |
196 | ||
197 | Rust is primarily distributed under the terms of both the MIT license | |
198 | and the Apache License (Version 2.0), with portions covered by various | |
199 | BSD-like licenses. | |
200 | ||
3157f602 XL |
201 | See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and |
202 | [COPYRIGHT](COPYRIGHT) for details. |