Skip to content

Commit 31166ec

Browse files
committed
rollup merge of rust-lang#22395: brson/readme-cleanup
Just a few things to make the README ever more perfect. r? @steveklabnik
2 parents c07ec50 + c273571 commit 31166ec

File tree

2 files changed

+25
-23
lines changed

2 files changed

+25
-23
lines changed

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# The Rust Programming Language
22

33
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.
57

68
## Quick Start
79

8-
Read ["Installing Rust"][install] from [The Book][trpl].
10+
Read ["Installing Rust"] from [The Book].
911

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
1214

1315
## Building from Source
1416

@@ -19,22 +21,14 @@ Read ["Installing Rust"][install] from [The Book][trpl].
1921
* `curl`
2022
* `git`
2123

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`:
3325

3426
$ git clone https://github.com/rust-lang/rust.git
3527
$ cd rust
3628

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:
3832

3933
$ ./configure
4034
$ make && make install
@@ -46,7 +40,10 @@ Read ["Installing Rust"][install] from [The Book][trpl].
4640
4741
When complete, `make install` will place several programs into
4842
`/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
5047

5148
### Building on Windows
5249

@@ -72,9 +69,6 @@ $ pacman -S base-devel
7269
$ ./configure
7370
$ make && make install
7471

75-
[repo]: https://github.com/rust-lang/rust
76-
[tarball]: https://static.rust-lang.org/dist/rustc-nightly-src.tar.gz
77-
7872
## Notes
7973

8074
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.
9488
Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
9589
swap, it will take a very long time to build.
9690

97-
There is a lot more documentation in the [wiki].
91+
There is more advice about hacking on Rust in [CONTRIBUTING.md].
9892

99-
[wiki]: https://github.com/rust-lang/rust/wiki
93+
[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
10094

10195
## Getting help
10296

@@ -114,6 +108,14 @@ The Rust community congregates in a few places:
114108

115109
To contribute to Rust, please see [CONTRIBUTING.md](CONTRIBUTING.md).
116110

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+
117119
## License
118120

119121
Rust is primarily distributed under the terms of both the MIT license

0 commit comments

Comments
 (0)