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.

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

Update readme with new pip instructions and reorganize #230

Merged
merged 5 commits into from
Dec 24, 2024
Merged

Update readme with new pip instructions and reorganize #230

merged 5 commits into from
Dec 24, 2024

Conversation

debermudez
Copy link
Contributor

Update the Readme to use the refined pip installation instructions.
Move the pip installation instructions to the top of the readme.

@debermudez debermudez marked this pull request as ready for review December 21, 2024 00:19
matthewkotila
matthewkotila reviewed Dec 21, 2024
View reviewed changes
genai-perf/README.md Outdated Show resolved Hide resolved
dyastremsky
dyastremsky reviewed Dec 21, 2024
View reviewed changes
Copy link
Contributor

@dyastremsky dyastremsky left a comment

Choose a reason for hiding this comment

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

I appreciate you making these changes! Improving the documentation, especially around install, is a great idea.

Do you also need to update the README template? I think we're also past 24.10 now.

genai-perf/README.md Outdated Show resolved Hide resolved
genai-perf/README.md Outdated Show resolved Hide resolved
genai-perf/README.md Outdated Show resolved Hide resolved
genai-perf/README.md Show resolved Hide resolved
dyastremsky
dyastremsky reviewed Dec 21, 2024
View reviewed changes
Copy link
Contributor

@dyastremsky dyastremsky left a comment

Choose a reason for hiding this comment

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

This looks good to me. Does the README template also need to be updated before approving/merging?

@debermudez
Copy link
Contributor Author

This looks good to me. Does the README template also need to be updated before approving/merging?

I did a pass on the templates.
Thanks for calling this out.

@debermudez debermudez merged commit ea2024d into main Dec 24, 2024
6 checks passed
@debermudez debermudez deleted the dbermudez-update-readme-install-instructions branch December 24, 2024 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matthewkotila matthewkotila matthewkotila left review comments

@dyastremsky dyastremsky dyastremsky 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
@debermudez @matthewkotila @dyastremsky