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

Update readme #58

Merged
merged 2 commits into from
Feb 14, 2024
Merged

Update readme #58

merged 2 commits into from
Feb 14, 2024

Conversation

TheMrAI
Copy link
Contributor

@TheMrAI TheMrAI commented Feb 14, 2024

Update the commit to use in the "Usage" section of the documentation and apply a few small cleanups to the README.md
markdown usage.

The previous version still had an issue whereas the user would get:
"The repository '@@com_github_bazelbuild_buildtools' could not be resolved:
Repository '@@com_github_bazelbuild_buildtools' is not defined. and referenced by
'@@bazel_clang_tidy//clang_tidy:clang_tidy'"
Added types to fenced blocks, that were missing it.
Replaced code block by indentation with regular fenced block.
Replaced numbered list usage to use only 1s instead of hard-coded
values. This makes it easier to add/remove list elements as
markdown will handle the number increment internally during list rendering.
@erenon
Copy link
Owner

erenon commented Feb 14, 2024

Thanks! Fixes #18.

@erenon erenon merged commit 4884c32 into erenon:master Feb 14, 2024
1 check 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.

2 participants