Skip to content

Update README.rst #7894

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 17, 2025
Merged

Update README.rst #7894

merged 1 commit into from
Jul 17, 2025

Conversation

Eisenwave
Copy link
Member

This PR makes the following changes:

  • Render the suggested package installation commands in code font for increased readability.
  • Suggest the alternative of using WSL on Windows. This is my personal setup, and considering that some of the scripts we have use Bash, our tooling is already biased towards Linux, so this is worth suggesting.
  • Mention the check-source.sh and check-output.sh scripts and how to use them. Especially considering that our CI doesn't work properly right now, it's a relevant thing to mention.

tkoeppe
tkoeppe reviewed Jun 16, 2025
View reviewed changes
@tkoeppe
Copy link
Contributor

tkoeppe commented Jun 17, 2025

Please rebase.

@jwakely
Copy link
Member

jwakely commented Jul 17, 2025

Render the suggested package installation commands in code font for increased readability.

Doesn't that already happen because of the indentation?

@Eisenwave
Copy link
Member Author

Doesn't that already happen because of the indentation?

It does. I'm not sure why I thought it doesn't at the time. This may be some weird Mandela effect thing - I am pretty sure that it rendered like

a Markdown blockquote

at the time, and I added code font to have it

indented and in code font.

Something must have changed about the way GitHub renders it, or I'm getting Mandela-effected pretty hard right now. Weird; lemme revert those changes.

@jwakely
Copy link
Member

jwakely commented Jul 17, 2025

Doesn't that already happen because of the indentation?

More precisely, it's the :: on the previous paragraph and the indentation.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks

@tkoeppe tkoeppe merged commit 601bc80 into cplusplus:main Jul 17, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tkoeppe tkoeppe tkoeppe left review comments

@jwakely jwakely jwakely approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Eisenwave @tkoeppe @jwakely