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

docs: cleanup readme #128

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: cleanup readme #128

wants to merge 2 commits into from

Conversation

vyas-n
Copy link
Collaborator

@vyas-n vyas-n commented Apr 25, 2024

This reformats the README file with GitHub recognized code blocks & equally spaced Markdown table.

@vyas-n vyas-n self-assigned this Apr 25, 2024
canterberry
canterberry previously approved these changes Apr 25, 2024
Copy link
Member

@canterberry canterberry left a comment

Choose a reason for hiding this comment

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

👍 LGTM. Just to confirm and summarize: I see code blocks (console -> shell), whitespace tweaks, and minor QoL tweaks.

joshsizer
joshsizer previously approved these changes Apr 26, 2024
Signed-off-by: Vyas Nellutla <[email protected]>
@vyas-n
Copy link
Collaborator Author

vyas-n commented May 20, 2024

Sorry, I need a re-review since I didn't originally sign the commit & needed to resolve a merge conflict.

@canterberry
Copy link
Member

Sorry, I need a re-review since I didn't originally sign the commit & needed to resolve a merge conflict.

Looks like there's still artifacts from a merge conflict in the README. In particular, have a look at the inputs table.

@vyas-n vyas-n marked this pull request as draft June 27, 2024 03:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants