Skip to content

Commit a06e5de

Browse files
committed
Link to other resources instead of inlining their information
The other places are more accurate and up-to-date. - Link to `std-dev-guide` in CONTRIBUTING.md Thom and Mara said the guide is in reasonably good shape, and it's tailored more closely to people working on the standard library. - Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme CONTRIBUTING.md has more information and also links the std-dev-guide. - Link to forge for the list of tested platforms; the one in the readme was hopelessly out of date.
1 parent 7632db0 commit a06e5de

File tree

2 files changed

+10
-34
lines changed

2 files changed

+10
-34
lines changed

CONTRIBUTING.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ members](https://rust-lang.zulipchat.com/#narrow/stream/122652-new-members)
88
Zulip stream. We have lots of docs below of how to get started on your own, but
99
the Zulip stream is the best place to *ask* for help.
1010

11-
Documentation for contributing to Rust is located in the [Guide to Rustc Development](https://rustc-dev-guide.rust-lang.org/),
12-
commonly known as the [rustc-dev-guide]. Despite the name, this guide documents
13-
not just how to develop rustc (the Rust compiler), but also how to contribute to the standard library and rustdoc.
11+
Documentation for contributing to the compiler or tooling is located in the [Guide to Rustc
12+
Development][rustc-dev-guide], commonly known as the [rustc-dev-guide]. Documentation for the
13+
standard library in the [Standard library developers Guide][std-dev-guide], commonly known as the [std-dev-guide].
1414

1515
## About the [rustc-dev-guide]
1616

@@ -35,6 +35,7 @@ refer to [this section][contributing-bug-reports] and [open an issue][issue temp
3535

3636
[Contributing to Rust]: https://rustc-dev-guide.rust-lang.org/contributing.html#contributing-to-rust
3737
[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/
38+
[std-dev-guide]: https://std-dev-guide.rust-lang.org/
3839
[contributing-bug-reports]: https://rustc-dev-guide.rust-lang.org/contributing.html#bug-reports
3940
[issue template]: https://github.com/rust-lang/rust/issues/new/choose
4041
[internals]: https://internals.rust-lang.org

README.md

+6-31
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@ standard library, and documentation.
66
[Rust]: https://www.rust-lang.org
77

88
**Note: this README is for _users_ rather than _contributors_.
9-
If you wish to _contribute_ to the compiler, you should read the
10-
[Getting Started][gettingstarted] section of the rustc-dev-guide instead.
11-
You can ask for help in the [#new members Zulip stream][new-members].**
12-
13-
[new-members]: https://rust-lang.zulipchat.com/#narrow/stream/122652-new-members
9+
If you wish to _contribute_ to the compiler, you should read [CONTRIBUTING.md](CONTRIBUTING.md) instead.
1410

1511
## Quick Start
1612

@@ -227,41 +223,20 @@ precompiled "snapshot" version of itself (made in an earlier stage of
227223
development). As such, source builds require an Internet connection to
228224
fetch snapshots, and an OS that can execute the available snapshot binaries.
229225
230-
Snapshot binaries are currently built and tested on several platforms:
231-
232-
| Platform / Architecture | x86 | x86_64 |
233-
|---------------------------------------------|-----|--------|
234-
| Windows (7, 8, 10, ...) | ✓ | ✓ |
235-
| Linux (kernel 3.2, glibc 2.17 or later) | ✓ | ✓ |
236-
| macOS (10.7 Lion or later) | (\*) | ✓ |
237-
238-
(\*): Apple dropped support for running 32-bit binaries starting from macOS 10.15 and iOS 11.
239-
Due to this decision from Apple, the targets are no longer useful to our users.
240-
Please read [our blog post][macx32] for more info.
241-
242-
[macx32]: https://blog.rust-lang.org/2020/01/03/reducing-support-for-32-bit-apple-targets.html
226+
See https://doc.rust-lang.org/nightly/rustc/platform-support.html for a list of supported platforms.
227+
Only "host tools" platforms have a pre-compiled snapshot binary available; to compile for a platform
228+
without host tools you must cross-compile.
243229
244230
You may find that other platforms work, but these are our officially
245231
supported build environments that are most likely to work.
246232
247233
## Getting Help
248234
249-
The Rust community congregates in a few places:
250-
251-
* [Stack Overflow] - Direct questions about using the language.
252-
* [users.rust-lang.org] - General discussion and broader questions.
253-
* [/r/rust] - News and general discussion.
254-
255-
[Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
256-
[/r/rust]: https://reddit.com/r/rust
257-
[users.rust-lang.org]: https://users.rust-lang.org/
235+
See https://www.rust-lang.org/community for a list of chat platforms and forums.
258236
259237
## Contributing
260238
261-
If you are interested in contributing to the Rust project, please take a look
262-
at the [Getting Started][gettingstarted] guide in the [rustc-dev-guide].
263-
264-
[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org
239+
See [CONTRIBUTING.md](CONTRIBUTING.md).
265240
266241
## License
267242

0 commit comments

Comments
 (0)