Update Readme #105553

atouchet · 2022-12-11T08:37:47Z

Update Readme to use consistent line lengths. Also update some formatting and links.

rustbot · 2022-12-11T08:37:54Z

(rustbot has picked a reviewer for you, use r? to override)

workingjubilee · 2022-12-11T11:10:07Z

README.md

+**Note: this README is for _users_ rather than _contributors_. If you wish to
+_contribute_ to the compiler, you should read the
+[Getting Started][gettingstarted] section of the rustc-dev-guide instead. You
+can ask for help in the [#new members Zulip stream][new-members].**


Markdown doesn't need orphan line starts like this: The previous way puts each individual topic on its own lines. That way diffs affect the appropriate lines and not irrelevant content.

That isn't consistent with how other paragraphs in the Readme are formatted though. What makes these two different?

Apologies for missing this question.

There's no need for excessive consistency. Alternatively, you can make them consistent in the more topic-oriented direction. Either a rule should be programmatically enforced, which I am fine with, or the formatting style should incline towards whatever is most natural, and thus will be most-preserved by subsequent edits.

I also didn't highlight all the line endings that I would not have changed this way, I merely did it to two examples to set a trend.

workingjubilee · 2022-12-11T11:10:51Z

README.md

+Systems such as Ubuntu 20.04 LTS do not create the necessary `python` command
+by default when Python is installed that allows `x.py` to be run directly. In
+that case, you can either create a symlink for `python` (Ubuntu provides the
+`python-is-python3` package for this), or run `x.py` using Python itself:


For the same reason, this should probably be broken up by sentence/fragment topic and not by a simple numeric line break.

Mark-Simulacrum · 2022-12-17T15:28:58Z

r? @workingjubilee

No strong opinions myself.

workingjubilee

I don't actually want to fuss much over this, because I think it's overall still an improvement. It's just formatting by line is arbitrary in a document that will be frequently read in a format that will concatenate all subsequent lines if they are without linebreaks, and inconsistency in formatting usually is between two different emergent formats, so we have an option of choosing one.

workingjubilee · 2022-12-24T11:02:01Z

README.md

+   # then replace "x86_64" below with "i686". If you've already got Git,
+   # Python, or CMake installed and in PATH you can remove them from this list.
+   # Note that it is important that you do **not** use the 'python2', 'cmake',


Obviously, I think this is largely an improvement.

workingjubilee · 2022-12-24T11:02:33Z

README.md

+   # and 'ninja' packages from the 'msys2' subsystem. The build has
+   # historically been known to fail with these packages.


Can move "The build" to a new line. Not required.

workingjubilee · 2022-12-24T11:03:41Z

README.md

+Right now, building Rust only works with some known versions of Visual Studio.
+If you have a more recent version installed and the build system doesn't


workingjubilee · 2022-12-24T11:03:56Z

README.md

+understand, you may need to force rustbuild to use an older version. This can
+be done by manually calling the appropriate vcvars file before running the


Optionally linebreak on "This".

workingjubilee · 2022-12-24T11:05:41Z

README.md

-| Linux (kernel 3.2, glibc 2.17 or later)     | ✓   | ✓      |
-| macOS (10.7 Lion or later)                  | (\*) | ✓      |
+| Platform / Architecture                 | x86  | x86_64 |
+|-----------------------------------------|------|--------|


Let's choose an alignment for these if we're going to fuss over them.

Suggested change

|-----------------------------------------|------|--------|

|-----------------------------------------|:----:|:------:|

workingjubilee · 2022-12-24T11:06:41Z

README.md

+| Windows (7, 8, 10, ...)                 | ✓    | ✓      |
+| Linux (kernel 3.2, glibc 2.17 or later) | ✓    | ✓      |
+| macOS (10.7 Lion or later)              | (\*) | ✓      |


They can remain left-justified in the source, obviously.

workingjubilee · 2022-12-24T11:08:10Z

README.md

-(\*): Apple dropped support for running 32-bit binaries starting from macOS 10.15 and iOS 11.
-Due to this decision from Apple, the targets are no longer useful to our users.
-Please read [our blog post][macx32] for more info.
+(\*): Apple dropped support for running 32-bit binaries starting from macOS
+10.15 and iOS 11. Due to this decision from Apple, the targets are no longer
+useful to our users. Please read [our blog post][macx32] for more info.


This is one of the examples of "less good". This is topic-split and now it gets line-broken and the next topic gets connected in unnecessarily.

workingjubilee · 2022-12-24T11:08:47Z

README.md

-the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
-`build\x86_64-pc-windows-msvc\doc`.
+The generated documentation will appear under `doc` in the `build` directory
+for the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory


Awkward Latin abbreviation in the middle of nowhere, worsens readability for no good reason, doesn't have to be changed her but if you have an opinion on what else could go here I'd be happy to see it.

Suggested change

for the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory

for the ABI used. That is, if the ABI was `x86_64-pc-windows-msvc`, the directory

workingjubilee · 2022-12-24T11:11:55Z

README.md

+"snapshot" version of itself (made in an earlier stage of development). As
+such, source builds require an Internet connection to fetch snapshots, and an
+OS that can execute the available snapshot binaries.


Again, opportunity for topical split:

Suggested change

"snapshot" version of itself (made in an earlier stage of development). As

such, source builds require an Internet connection to fetch snapshots, and an

OS that can execute the available snapshot binaries.

"snapshot" version of itself (made in an earlier stage of development).

As such, source builds require an Internet connection to fetch snapshots,

and an OS that can execute the available snapshot binaries.

workingjubilee · 2022-12-24T11:13:24Z

README.md

+   source tree to determine various configuration settings for the build. Copy
+   the default `config.toml.example` to `config.toml` to get started.


Suggested change

source tree to determine various configuration settings for the build. Copy

the default `config.toml.example` to `config.toml` to get started.

source tree to determine various configuration settings for the build.

Copy the default `config.toml.example` to `config.toml` to get started.

bors · 2022-12-24T14:27:32Z

☔ The latest upstream changes (presumably #106111) made this pull request unmergeable. Please resolve the merge conflicts.

atouchet · 2022-12-24T20:41:34Z

The Readme was modified quite a bit in #105465. I will open a new PR based on the new version with requested edits.

Improve Markdown styling in README Update Readme to use consistent line lengths. Also update some formatting and links. (Followup to rust-lang#105553). r? `@workingjubilee`

Improve Markdown styling in README Update Readme to use consistent line lengths. Also update some formatting and links. (Followup to rust-lang#105553). r? ``@workingjubilee``

Update Readme

ff21c26

rustbot assigned Mark-Simulacrum Dec 11, 2022

rustbot added A-meta Area: Issues & PRs about the rust-lang/rust repository itself S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 11, 2022

workingjubilee reviewed Dec 11, 2022

View reviewed changes

rustbot assigned workingjubilee and unassigned Mark-Simulacrum Dec 17, 2022

workingjubilee reviewed Dec 24, 2022

View reviewed changes

atouchet closed this Dec 24, 2022

This was referenced Dec 24, 2022

Improve markdown styling in README #106128

Closed

Improve Markdown styling in README #106244

Merged

atouchet deleted the readme branch January 18, 2023 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Readme #105553

Update Readme #105553

atouchet commented Dec 11, 2022

rustbot commented Dec 11, 2022

workingjubilee Dec 11, 2022

atouchet Dec 12, 2022

workingjubilee Dec 24, 2022

workingjubilee Dec 11, 2022

Mark-Simulacrum commented Dec 17, 2022

workingjubilee left a comment

workingjubilee Dec 24, 2022

workingjubilee Dec 24, 2022

workingjubilee Dec 24, 2022

workingjubilee Dec 24, 2022

workingjubilee Dec 24, 2022

workingjubilee Dec 24, 2022

workingjubilee Dec 24, 2022

workingjubilee Dec 24, 2022

workingjubilee Dec 24, 2022

workingjubilee Dec 24, 2022

bors commented Dec 24, 2022

atouchet commented Dec 24, 2022

		# and 'ninja' packages from the 'msys2' subsystem. The build has
		# historically been known to fail with these packages.

		Right now, building Rust only works with some known versions of Visual Studio.
		If you have a more recent version installed and the build system doesn't

		understand, you may need to force rustbuild to use an older version. This can
		be done by manually calling the appropriate vcvars file before running the

	\|-----------------------------------------\|------\|--------\|
	\|-----------------------------------------\|:----:\|:------:\|

	for the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory
	for the ABI used. That is, if the ABI was `x86_64-pc-windows-msvc`, the directory

		source tree to determine various configuration settings for the build. Copy
		the default `config.toml.example` to `config.toml` to get started.

Update Readme #105553

Update Readme #105553

Conversation

atouchet commented Dec 11, 2022

rustbot commented Dec 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mark-Simulacrum commented Dec 17, 2022

workingjubilee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bors commented Dec 24, 2022

atouchet commented Dec 24, 2022