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

Minor edits to README #1832

Merged
merged 2 commits into from
Mar 26, 2024
Merged

Conversation

Rageking8
Copy link
Contributor

@Rageking8 Rageking8 commented Mar 21, 2024

Summary of changes:

  • Added backticks to improve readability
  • Prefer single backtick for inline code/term rather that triple backticks
  • Fixed a couple of errors (e.g. Vk::Result (should be lowercase "v"))
  • Tweaked some sentences to correct grammer/improve flow
  • Attempted to normalize code snippet conventions (e.g. size of indentation, placement of braces, use of spacing, use of qualified identifiers)
  • Added links to headers/guides for first references (subsequent references are just enclosing in backticks with no link)
  • Added usage of IMPORTANT and NOTE alerts

@CLAassistant
Copy link

CLAassistant commented Mar 21, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@asuessenbach asuessenbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's some great improvement to the readme! Thanks a lot for your contribution.

There are just a couple of minor issues I'd like you to resolve.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Rageking8
Copy link
Contributor Author

Rageking8 commented Mar 25, 2024

Addressed all feedback given and did another light edit pass over the whole README file. It includes more escaping with backticks, using qualified names, some formatting, and fixing a few more errors found ("IndexType::eUint32" (typo) and "vk::UniqueHandles" (should not have a trailing "s")).

@asuessenbach
Copy link
Contributor

Thanks a lot for this nice improvements of the readme!

@asuessenbach asuessenbach merged commit 268fb77 into KhronosGroup:main Mar 26, 2024
12 checks passed
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.

3 participants