-
-
Notifications
You must be signed in to change notification settings - Fork 14.9k
Don't bias README.md towards distros #118627
Copy link
Copy link
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsE-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-help-wantedCall for participation: Help is requested to fix this issue.Call for participation: Help is requested to fix this issue.
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsE-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-help-wantedCall for participation: Help is requested to fix this issue.Call for participation: Help is requested to fix this issue.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Location
README.md
Summary
Currently, the top-level readme looks something like this:
This makes it really easy for someone to quickly look at the readme, see that it suggests
./configure, and run that locally. Unfortunately, that will be the wrong thing to do for 99% of contributors, because configure setsprofile = "dist"at the top. Additionally, it's not really serving actual users of rust, who almost certainly don't want to compile from source (they either want to install from rustup or from their distro).I suggest moving the vast majority of the README into a separate file, perhaps called
INSTALLING_FROM_SOURCE.md, and making the top-level README only contain the sections preceding "Installing from source" and following "Notes". That should make it a lot more clear that it's not intended for either users or devs.@rustbot label +E-easy +E-help-wanted