From 4acc48310678f67461c8db15f6f9351577a53f09 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Sun, 15 Feb 2015 20:20:25 -0800 Subject: [PATCH 1/8] Simplify README by not talking about the source tarball option I believe that few enough people build from source tarballs that we don't have to talk about it explicitly. --- README.md | 19 ++++--------------- src/llvm | 2 +- 2 files changed, 5 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 065c4ed7c7bcb..a0ebfc6927322 100644 --- a/README.md +++ b/README.md @@ -19,22 +19,14 @@ Read ["Installing Rust"][install] from [The Book][trpl]. * `curl` * `git` -2. Download and build Rust: - - You can either download a [tarball] or build directly from the [repo]. - - To build from the [tarball] do: - - $ curl -O https://static.rust-lang.org/dist/rustc-nightly-src.tar.gz - $ tar -xzf rustc-nightly-src.tar.gz - $ cd rustc-nightly - - Or to build from the [repo] do: +2. Clone the [source] with git: $ git clone https://github.com/rust-lang/rust.git $ cd rust - Now that you have Rust's source code, you can configure and build it: +[source]: https://github.com/rust-lang/rust + +3. Build and install: $ ./configure $ make && make install @@ -72,9 +64,6 @@ $ pacman -S base-devel $ ./configure $ make && make install -[repo]: https://github.com/rust-lang/rust -[tarball]: https://static.rust-lang.org/dist/rustc-nightly-src.tar.gz - ## Notes Since the Rust compiler is written in Rust, it must be built by a diff --git a/src/llvm b/src/llvm index 2089cab13e7f9..4891e6382e3e8 160000 --- a/src/llvm +++ b/src/llvm @@ -1 +1 @@ -Subproject commit 2089cab13e7f92b487ba0dc1df9f6c05116b004a +Subproject commit 4891e6382e3e8aa89d530aa18427836428c47157 From 21ed20baf932dd092cc80b0f4ade38dd7aa7c788 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Sun, 15 Feb 2015 20:41:16 -0800 Subject: [PATCH 2/8] README: Give a hint about how to build Cargo from source. Just a hint. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a0ebfc6927322..f13bc287fabdb 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,10 @@ Read ["Installing Rust"][install] from [The Book][trpl]. When complete, `make install` will place several programs into `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the - API-documentation tool. + API-documentation tool. This install does not include [Cargo], + Rust's package manager, which you may also want to build. + +[Cargo]: https://github.com/rust-lang/cargo ### Building on Windows From 9265e13867ddad092e709097e20ff3b513635670 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Sun, 15 Feb 2015 20:46:21 -0800 Subject: [PATCH 3/8] README: Make the wiki links more useful. The page we want them to find is 'getting started developing'. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f13bc287fabdb..1caabfd27dc89 100644 --- a/README.md +++ b/README.md @@ -86,8 +86,9 @@ supported build environments that are most likely to work. Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits swap, it will take a very long time to build. -There is a lot more documentation in the [wiki]. +There is more advice about [hacking on Rust][hack] on the [wiki]. +[hack]: https://github.com/rust-lang/rust/wiki/Note-getting-started-developing-Rust [wiki]: https://github.com/rust-lang/rust/wiki ## Getting help From 46189559a9449de3a7eacf70652aec8a994c9220 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Sun, 15 Feb 2015 20:58:06 -0800 Subject: [PATCH 4/8] README: Add a link to #rust --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 1caabfd27dc89..e37f1aec2d573 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,14 @@ The Rust community congregates in a few places: To contribute to Rust, please see [CONTRIBUTING.md](CONTRIBUTING.md). +Rust has an [IRC] culture and most real-time collaboration happens in a +variety of channels on Mozilla's IRC network, irc.mozilla.org. The +most popular channel is [#rust], a venue for general discussion about +Rust, and a good place to ask for help, + +[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat +[#rust]: https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust + ## License Rust is primarily distributed under the terms of both the MIT license From aaabdbfe049cb4eaa2a353f4ce1bc59862a6b49e Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Sun, 15 Feb 2015 21:08:32 -0800 Subject: [PATCH 5/8] README: Add one sentence about what Rust is. Most people don't know what Rust is. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e37f1aec2d573..fd6d3723276f9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # The Rust Programming Language This is a compiler for Rust, including standard libraries, tools and -documentation. +documentation. Rust is a systems programming language that is fast, +memory safe and multithreaded, but does not employ a garbage collector +or otherwise impose significant runtime overhead. ## Quick Start From 73cc4ed4daa0d33ddbcb06fb918fbe9a297f8b8a Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Sun, 15 Feb 2015 21:20:27 -0800 Subject: [PATCH 6/8] README: Simplify markdown --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fd6d3723276f9..36f4e1fa5be02 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@ or otherwise impose significant runtime overhead. ## Quick Start -Read ["Installing Rust"][install] from [The Book][trpl]. +Read ["Installing Rust"] from [The Book]. -[install]: http://doc.rust-lang.org/book/installing-rust.html -[trpl]: http://doc.rust-lang.org/book/index.html +["Installing Rust"]: http://doc.rust-lang.org/book/installing-rust.html +[The Book]: http://doc.rust-lang.org/book/index.html ## Building from Source From 7430e58e65b26e4b5b738392b192e4b9c836797b Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Wed, 18 Feb 2015 13:46:20 -0800 Subject: [PATCH 7/8] Address review feedback --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 36f4e1fa5be02..85c2721821836 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Read ["Installing Rust"] from [The Book]. * `curl` * `git` -2. Clone the [source] with git: +2. Clone the [source] with `git`: $ git clone https://github.com/rust-lang/rust.git $ cd rust @@ -90,7 +90,7 @@ swap, it will take a very long time to build. There is more advice about [hacking on Rust][hack] on the [wiki]. -[hack]: https://github.com/rust-lang/rust/wiki/Note-getting-started-developing-Rust +[hack]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md [wiki]: https://github.com/rust-lang/rust/wiki ## Getting help @@ -115,7 +115,7 @@ most popular channel is [#rust], a venue for general discussion about Rust, and a good place to ask for help, [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat -[#rust]: https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust +[#rust]: irc://irc.mozilla.org/rust ## License From c273571bfdb5b3aefba1a29a19b6da601d8c5626 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Wed, 18 Feb 2015 13:48:46 -0800 Subject: [PATCH 8/8] Remove mention of wiki from README --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 85c2721821836..b6a73730d351c 100644 --- a/README.md +++ b/README.md @@ -88,10 +88,9 @@ supported build environments that are most likely to work. Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits swap, it will take a very long time to build. -There is more advice about [hacking on Rust][hack] on the [wiki]. +There is more advice about hacking on Rust in [CONTRIBUTING.md]. -[hack]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md -[wiki]: https://github.com/rust-lang/rust/wiki +[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md ## Getting help