]> git.lizzy.rs Git - rust.git/blobdiff - README.md
move contributing.md to rustc-dev-guide and point at getting started
[rust.git] / README.md
index 42fc0a63c0ffbd9f87699a9f3fbddbd5341baa0d..44c618a0518dad2b68a6675423a51d560c671a57 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,6 +5,8 @@ standard library, and documentation.
 
 [Rust]: https://www.rust-lang.org
 
+**Note: this README is for _users_ rather than _contributors_.**
+
 ## Quick Start
 
 Read ["Installation"] from [The Book].
@@ -14,13 +16,15 @@ Read ["Installation"] from [The Book].
 
 ## Installing from Source
 
-_Note: If you wish to contribute to the compiler, you should read [this
-chapter][rustcguidebuild] of the rustc-dev-guide instead of this section._
+**Note: If you wish to _contribute_ to the compiler, you should read the
+[Getting Started][gettingstarted] of the rustc-dev-guide instead of this
+section.**
 
 The Rust build system has a Python script called `x.py` to bootstrap building
 the compiler. More information about it may be found by running `./x.py --help`
 or reading the [rustc dev guide][rustcguidebuild].
 
+[gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.md
 [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html
 
 ### Building on a Unix-like system
@@ -224,10 +228,6 @@ Snapshot binaries are currently built and tested on several platforms:
 You may find that other platforms work, but these are our officially
 supported build environments that are most likely to work.
 
-There is more advice about hacking on Rust in [CONTRIBUTING.md].
-
-[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
-
 ## Getting Help
 
 The Rust community congregates in a few places:
@@ -242,21 +242,8 @@ The Rust community congregates in a few places:
 
 ## Contributing
 
-To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
-
-Most real-time collaboration happens in a variety of channels on the
-[Rust Discord server][rust-discord], with channels dedicated for getting help,
-community, documentation, and all major contribution areas in the Rust ecosystem.
-A good place to ask for help would be the #help channel.
-
-The [rustc dev guide] might be a good place to start if you want to find out how
-various parts of the compiler work.
-
-Also, you may find the [rustdocs for the compiler itself][rustdocs] useful.
-
-[rust-discord]: https://discord.gg/rust-lang
-[rustc dev guide]: https://rustc-dev-guide.rust-lang.org/about-this-guide.html
-[rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
+If you are interested in contributing to the Rust project, please take a look
+at the [Getting Started][gettingstarted] guide in the [rustc-dev-guide].
 
 ## License