I just had a mentee think they have to do
x.py install to do their development because that's what it says in the quick-start guide of https://github.com/rust-lang/rust/blob/master/README.md
A much better place for them to find would have been https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#building
I wonder if it is worth putting that more prominently in the README, or putting the manual install instructions (which we dont really want anyone to use) further down or even into a separate file.
Cc @Steve Klabnik
@RalfJ we might want to prominently link to the rustc guide in the readme if not done already?
like "this readme may be outdated... refer to the rustc guide first"
it's linked but may below these install instructions
if its outdated maybe we should just remove most of its content?^^
yeah maybe; I really like: https://rust-lang.github.io/rustc-guide/tests/intro.html
@RalfJ it makes sense not to duplicate content because inevitably the readme will be outdated when changes to the guide are made
cause people forget to update the readme...
well mostly I am not sure what the purpose of he README is -- who's expected to go there for which information. it's kind of the "start page" on the repo on github, after all
In the short term it seems like it would be reasonable to at least change the "Build and install" step into two distinct "build" and "install" steps, and mark the "install" step optional.
#57746 did at least add an additional link to the rustc-guide
so we got https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html and https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md with quite some overlap, it seems?