]>
Commit | Line | Data |
---|---|---|
223e47cc LB |
1 | # The Rust Programming Language |
2 | ||
62682a34 SL |
3 | Rust is a fast systems programming language that guarantees |
4 | memory safety and offers painless concurrency ([no data races]). | |
5 | It does not employ a garbage collector and has minimal runtime overhead. | |
6 | ||
c1a9b12d | 7 | This repo contains the code for the compiler (`rustc`), as well |
62682a34 SL |
8 | as standard libraries, tools and documentation for Rust. |
9 | ||
10 | [no data races]: http://blog.rust-lang.org/2015/04/10/Fearless-Concurrency.html | |
223e47cc | 11 | |
1a4d82fc | 12 | ## Quick Start |
223e47cc | 13 | |
85aaf69f | 14 | Read ["Installing Rust"] from [The Book]. |
223e47cc | 15 | |
85aaf69f SL |
16 | ["Installing Rust"]: http://doc.rust-lang.org/book/installing-rust.html |
17 | [The Book]: http://doc.rust-lang.org/book/index.html | |
223e47cc | 18 | |
1a4d82fc | 19 | ## Building from Source |
223e47cc | 20 | |
1a4d82fc | 21 | 1. Make sure you have installed the dependencies: |
c34b1796 AL |
22 | |
23 | * `g++` 4.7 or `clang++` 3.x | |
24 | * `python` 2.6 or later (but not 3.x) | |
25 | * GNU `make` 3.81 or later | |
26 | * `curl` | |
27 | * `git` | |
1a4d82fc | 28 | |
85aaf69f | 29 | 2. Clone the [source] with `git`: |
1a4d82fc | 30 | |
c34b1796 AL |
31 | ```sh |
32 | $ git clone https://github.com/rust-lang/rust.git | |
33 | $ cd rust | |
34 | ``` | |
1a4d82fc | 35 | |
85aaf69f SL |
36 | [source]: https://github.com/rust-lang/rust |
37 | ||
38 | 3. Build and install: | |
223e47cc | 39 | |
c34b1796 AL |
40 | ```sh |
41 | $ ./configure | |
42 | $ make && make install | |
43 | ``` | |
223e47cc | 44 | |
c34b1796 AL |
45 | > ***Note:*** You may need to use `sudo make install` if you do not |
46 | > normally have permission to modify the destination directory. The | |
47 | > install locations can be adjusted by passing a `--prefix` argument | |
48 | > to `configure`. Various other options are also supported – pass | |
49 | > `--help` for more information on them. | |
223e47cc | 50 | |
1a4d82fc JJ |
51 | When complete, `make install` will place several programs into |
52 | `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the | |
85aaf69f SL |
53 | API-documentation tool. This install does not include [Cargo], |
54 | Rust's package manager, which you may also want to build. | |
55 | ||
56 | [Cargo]: https://github.com/rust-lang/cargo | |
223e47cc | 57 | |
1a4d82fc | 58 | ### Building on Windows |
223e47cc | 59 | |
c34b1796 | 60 | [MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows: |
223e47cc | 61 | |
1a4d82fc | 62 | 1. Grab the latest MSYS2 installer and go through the installer. |
223e47cc | 63 | |
c34b1796 AL |
64 | 2. From the MSYS2 terminal, install the `mingw64` toolchain and other required |
65 | tools. | |
66 | ||
67 | ```sh | |
68 | # Choose one based on platform: | |
69 | $ pacman -S mingw-w64-i686-toolchain | |
70 | $ pacman -S mingw-w64-x86_64-toolchain | |
71 | ||
72 | $ pacman -S base-devel | |
73 | ``` | |
223e47cc | 74 | |
c34b1796 | 75 | 3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed |
c1a9b12d | 76 | MSYS2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust. |
85aaf69f | 77 | |
c34b1796 | 78 | 4. Navigate to Rust's source code, configure and build it: |
1a4d82fc | 79 | |
c34b1796 AL |
80 | ```sh |
81 | $ ./configure | |
82 | $ make && make install | |
83 | ``` | |
1a4d82fc | 84 | |
1a4d82fc JJ |
85 | ## Notes |
86 | ||
87 | Since the Rust compiler is written in Rust, it must be built by a | |
88 | precompiled "snapshot" version of itself (made in an earlier state of | |
89 | development). As such, source builds require a connection to the Internet, to | |
90 | fetch snapshots, and an OS that can execute the available snapshot binaries. | |
91 | ||
92 | Snapshot binaries are currently built and tested on several platforms: | |
223e47cc | 93 | |
d9579d0f AL |
94 | | Platform \ Architecture | x86 | x86_64 | |
95 | |--------------------------------|-----|--------| | |
96 | | Windows (7, 8, Server 2008 R2) | ✓ | ✓ | | |
97 | | Linux (2.6.18 or later) | ✓ | ✓ | | |
98 | | OSX (10.7 Lion or later) | ✓ | ✓ | | |
1a4d82fc JJ |
99 | |
100 | You may find that other platforms work, but these are our officially | |
101 | supported build environments that are most likely to work. | |
102 | ||
103 | Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits | |
104 | swap, it will take a very long time to build. | |
105 | ||
85aaf69f | 106 | There is more advice about hacking on Rust in [CONTRIBUTING.md]. |
1a4d82fc | 107 | |
85aaf69f | 108 | [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md |
1a4d82fc | 109 | |
c34b1796 | 110 | ## Getting Help |
1a4d82fc JJ |
111 | |
112 | The Rust community congregates in a few places: | |
113 | ||
c34b1796 AL |
114 | * [Stack Overflow] - Direct questions about using the language. |
115 | * [users.rust-lang.org] - General discussion and broader questions. | |
85aaf69f | 116 | * [/r/rust] - News and general discussion. |
1a4d82fc | 117 | |
c34b1796 | 118 | [Stack Overflow]: http://stackoverflow.com/questions/tagged/rust |
1a4d82fc | 119 | [/r/rust]: http://reddit.com/r/rust |
85aaf69f SL |
120 | [users.rust-lang.org]: http://users.rust-lang.org/ |
121 | ||
122 | ## Contributing | |
123 | ||
c34b1796 | 124 | To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md). |
85aaf69f SL |
125 | |
126 | Rust has an [IRC] culture and most real-time collaboration happens in a | |
127 | variety of channels on Mozilla's IRC network, irc.mozilla.org. The | |
128 | most popular channel is [#rust], a venue for general discussion about | |
c34b1796 | 129 | Rust, and a good place to ask for help. |
85aaf69f SL |
130 | |
131 | [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat | |
132 | [#rust]: irc://irc.mozilla.org/rust | |
223e47cc LB |
133 | |
134 | ## License | |
135 | ||
136 | Rust is primarily distributed under the terms of both the MIT license | |
137 | and the Apache License (Version 2.0), with portions covered by various | |
138 | BSD-like licenses. | |
139 | ||
c34b1796 | 140 | See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details. |