Skip to content

Conversation

KisaragiEffective
Copy link

@KisaragiEffective KisaragiEffective commented May 12, 2022

What have been done in this PR

  • This converts indented code blocks to fenced style1.
  • This adds info-string2 to improve accessibility. The README does not specify where to type the commands. If they have info-string, it will make easier to understand how to build.

Footnotes

  1. It is required to add info-string, indented one can't have info-string2.

  2. An info-string is used to determine how it will be highlighted by GitHub Flavored Markdown (calling GFM) parser. 2

@CLAassistant
Copy link

CLAassistant commented May 12, 2022

CLA assistant check
All committers have signed the CLA.

@aritger
Copy link
Collaborator

aritger commented Jun 29, 2022

Thanks for the suggestion, but I'm happy enough with the current formatting of these commands in README.md, so I'm inclined to leave this as-is. I'm going to go ahead and close, but let me know if there is some benefit to code-block highlight (sorry, I don't know github's markdown that well, so I could be missing something).

@aritger aritger closed this Jun 29, 2022
@KisaragiEffective
Copy link
Author

@aritger
Thanks for your review! I've updated the description to explain benefits. I'm glad if you would re-consider this PR, thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants