-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
fix: demo readme formatting #1570
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @katiemn and reviewers,
I'm currently reviewing this pull request and will post my full review in a few minutes. In the meantime, here's a quick summary to get everyone up to speed:
This PR aims to improve the readability and formatting of the Multimodal Live Demo README.md file. Specifically, the changes focus on correcting the ordering and presentation of the steps involved in setting up and running the demo application.
Here's a breakdown of the changes:
- File Changed:
gemini/multimodal-live-api/websocket-demo-app/README.md
- Changes Made:
- The code blocks for the setup instructions (using
git clone
,python3 -m venv
,pip3 install
, etc.) have been consistently indented to improve visual clarity. This is done in two sections of the README. The first section is lines 35-87, and the second section is lines 90-168. - List items (numbered steps) have been consistently formatted with leading spaces to ensure proper ordering and readability. This is also done in two sections of the README. The first section is lines 35-87, and the second section is lines 90-168.
- The code blocks for the setup instructions (using
The overall effect is a cleaner, more user-friendly README that makes it easier for users to follow the setup instructions.
And now, a little haiku to brighten your day:
Code flows like a stream,
Readme's clarity shines bright,
Demo runs with ease.
Thanks!
Gemini
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This pull request improves the formatting of the README.md
file for the Multimodal Live Demo by adding indentation to the code blocks and list items. This significantly enhances the readability and overall presentation of the setup instructions. The consistent indentation makes the steps clearer and easier to follow. No further issues were found.
Update the spacing in the Multimodal Live Demo README so the list is ordered correctly.