Stream: general

Topic: Build instructions in README


RalfJ (Jan 04 2019 at 13:38, on Zulip):

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

RalfJ (Jan 04 2019 at 13:38, on Zulip):

A much better place for them to find would have been https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#building

RalfJ (Jan 04 2019 at 13:40, on Zulip):

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.

RalfJ (Jan 04 2019 at 13:40, on Zulip):

Cc @Steve Klabnik

centril (Jan 04 2019 at 20:56, on Zulip):

@RalfJ we might want to prominently link to the rustc guide in the readme if not done already?

centril (Jan 04 2019 at 20:57, on Zulip):

like "this readme may be outdated... refer to the rustc guide first"

RalfJ (Jan 04 2019 at 20:57, on Zulip):

it's linked but may below these install instructions

RalfJ (Jan 04 2019 at 20:57, on Zulip):

if its outdated maybe we should just remove most of its content?^^

centril (Jan 04 2019 at 20:57, on Zulip):

yeah maybe; I really like: https://rust-lang.github.io/rustc-guide/tests/intro.html

centril (Jan 04 2019 at 20:58, on Zulip):

and: https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html

centril (Jan 04 2019 at 20:59, on Zulip):

@RalfJ it makes sense not to duplicate content because inevitably the readme will be outdated when changes to the guide are made

centril (Jan 04 2019 at 20:59, on Zulip):

cause people forget to update the readme...

RalfJ (Jan 05 2019 at 10:41, on Zulip):

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

pnkfelix (Jan 31 2019 at 13:39, on Zulip):

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.

pnkfelix (Jan 31 2019 at 13:40, on Zulip):

#57746 did at least add an additional link to the rustc-guide

RalfJ (Jan 31 2019 at 13:53, on Zulip):

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?

Last update: Nov 20 2019 at 13:00UTC