Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't bias README.md towards distros #118627

Closed
jyn514 opened this issue Dec 5, 2023 · 3 comments
Closed

Don't bias README.md towards distros #118627

jyn514 opened this issue Dec 5, 2023 · 3 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue.

Comments

@jyn514
Copy link
Member

jyn514 commented Dec 5, 2023

Location

README.md

Summary

Currently, the top-level readme looks something like this:

# THE RUST PROGRAMMING LANGUAGE

blah blah boilerplate

this readme is for users, not contributors

TABLE OF CONTENTS

read this if you are a user

HERE ARE 500 LINES ABOUT HOW DISTROS SHOULD COMPLE RUSTC FROM SRC
IT GOES ON FOR A LONG TIME
IT HAS CODE SNIPPETS AND EVERYTHING
```
./configure
```
LOOK AREN'T THESE CODE SNIPPETS SO INVITING
```
make
```

blah blah licensing

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 sets profile = "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

@jyn514 jyn514 added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Dec 5, 2023
@rustbot rustbot added needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Dec 5, 2023
@crlf0710
Copy link
Member

crlf0710 commented Dec 5, 2023

I submitted a PR to move the contents to forge. After it's merged and deployed maybe we could just link to that.

@jyn514
Copy link
Member Author

jyn514 commented Dec 5, 2023

hmm, ok. I worry that it will get out of date there since it won't show up with ripgrep, but it seems better than having it front and center in the readme.

@saethlin saethlin removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Dec 5, 2023
@rustbot rustbot added the E-help-wanted Call for participation: Help is requested to fix this issue. label Dec 6, 2023
Noratrieb added a commit to Noratrieb/rust that referenced this issue Jan 13, 2024
…ource, r=Mark-Simulacrum

Move section "Installing from Source" to seperate file

cc rust-lang#118627
Noratrieb added a commit to Noratrieb/rust that referenced this issue Jan 13, 2024
…ource, r=Mark-Simulacrum

Move section "Installing from Source" to seperate file

cc rust-lang#118627
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jan 13, 2024
…ource, r=Mark-Simulacrum

Move section "Installing from Source" to seperate file

cc rust-lang#118627
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Jan 14, 2024
Rollup merge of rust-lang#119189 - henrispriet:move-installing-from-source, r=Mark-Simulacrum

Move section "Installing from Source" to seperate file

cc rust-lang#118627
@homersimpsons
Copy link
Contributor

Looks like this can be closed with #119189

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue.
Projects
None yet
Development

No branches or pull requests

6 participants