1
1
# The Rust Programming Language
2
2
3
3
This is a compiler for Rust, including standard libraries, tools and
4
- documentation.
4
+ documentation. Rust is a systems programming language that is fast,
5
+ memory safe and multithreaded, but does not employ a garbage collector
6
+ or otherwise impose significant runtime overhead.
5
7
6
8
## Quick Start
7
9
8
- Read [ "Installing Rust"] [ install ] from [ The Book] [ trpl ] .
10
+ Read [ "Installing Rust"] from [ The Book] .
9
11
10
- [ install ] : http://doc.rust-lang.org/book/installing-rust.html
11
- [ trpl ] : http://doc.rust-lang.org/book/index.html
12
+ [ "Installing Rust" ] : http://doc.rust-lang.org/book/installing-rust.html
13
+ [ The Book ] : http://doc.rust-lang.org/book/index.html
12
14
13
15
## Building from Source
14
16
@@ -19,22 +21,14 @@ Read ["Installing Rust"][install] from [The Book][trpl].
19
21
* ` curl `
20
22
* ` git `
21
23
22
- 2 . Download and build Rust:
23
-
24
- You can either download a [ tarball] or build directly from the [ repo] .
25
-
26
- To build from the [ tarball] do:
27
-
28
- $ curl -O https://static.rust-lang.org/dist/rustc-nightly-src.tar.gz
29
- $ tar -xzf rustc-nightly-src.tar.gz
30
- $ cd rustc-nightly
31
-
32
- Or to build from the [ repo] do:
24
+ 2 . Clone the [ source] with ` git ` :
33
25
34
26
$ git clone https://github.com/rust-lang/rust.git
35
27
$ cd rust
36
28
37
- Now that you have Rust's source code, you can configure and build it:
29
+ [ source ] : https://github.com/rust-lang/rust
30
+
31
+ 3 . Build and install:
38
32
39
33
$ ./configure
40
34
$ make && make install
@@ -46,7 +40,10 @@ Read ["Installing Rust"][install] from [The Book][trpl].
46
40
47
41
When complete, ` make install ` will place several programs into
48
42
` /usr/local/bin ` : ` rustc ` , the Rust compiler, and ` rustdoc ` , the
49
- API-documentation tool.
43
+ API-documentation tool. This install does not include [ Cargo] ,
44
+ Rust's package manager, which you may also want to build.
45
+
46
+ [ Cargo ] : https://github.com/rust-lang/cargo
50
47
51
48
### Building on Windows
52
49
@@ -72,9 +69,6 @@ $ pacman -S base-devel
72
69
$ ./configure
73
70
$ make && make install
74
71
75
- [ repo ] : https://github.com/rust-lang/rust
76
- [ tarball ] : https://static.rust-lang.org/dist/rustc-nightly-src.tar.gz
77
-
78
72
## Notes
79
73
80
74
Since the Rust compiler is written in Rust, it must be built by a
@@ -94,9 +88,9 @@ supported build environments that are most likely to work.
94
88
Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
95
89
swap, it will take a very long time to build.
96
90
97
- There is a lot more documentation in the [ wiki ] .
91
+ There is more advice about hacking on Rust in [ CONTRIBUTING.md ] .
98
92
99
- [ wiki ] : https://github.com/rust-lang/rust/wiki
93
+ [ CONTRIBUTING.md ] : https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
100
94
101
95
## Getting help
102
96
@@ -114,6 +108,14 @@ The Rust community congregates in a few places:
114
108
115
109
To contribute to Rust, please see [ CONTRIBUTING.md] ( CONTRIBUTING.md ) .
116
110
111
+ Rust has an [ IRC] culture and most real-time collaboration happens in a
112
+ variety of channels on Mozilla's IRC network, irc.mozilla.org. The
113
+ most popular channel is [ #rust] , a venue for general discussion about
114
+ Rust, and a good place to ask for help,
115
+
116
+ [ IRC ] : https://en.wikipedia.org/wiki/Internet_Relay_Chat
117
+ [ #rust ] : irc://irc.mozilla.org/rust
118
+
117
119
## License
118
120
119
121
Rust is primarily distributed under the terms of both the MIT license
0 commit comments