-
Notifications
You must be signed in to change notification settings - Fork 66
update readme #411
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 #411
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.
Summary of Changes
Hello @helloyongyang, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on a minor documentation update, specifically correcting or updating a DeepWiki badge link within the project's main README files. The change ensures that the link directs users to the correct resource.
Highlights
- Documentation Update: Updated the DeepWiki badge link in both the English (
README.md) and Chinese (README_zh.md) versions of the README file. The link now points toModelTC/LightCompressinstead ofModelTC/llmc.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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.
Code Review
This pull request updates the DeepWiki badge link in both the English and Chinese README files to reflect the repository's name change from llmc to LightCompress. The changes are correct, but incomplete. I've pointed out that the Star History badge links in both READMEs also need to be updated for consistency. Applying these suggestions will complete the update.
|
|
||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| [](https://deepwiki.com/ModelTC/llmc) | ||
| [](https://deepwiki.com/ModelTC/LightCompress) |
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.
Thanks for updating the DeepWiki link to reflect the repository's new name, LightCompress. This is a good correction.
However, the update seems incomplete as other parts of the file still refer to the old repository name. For instance, the Star History badge on line 218 still points to ModelTC/llmc.
To ensure consistency throughout the document, could you please update it as well?
Suggested change for line 218:
[](https://star-history.com/#ModelTC/LightCompress&Timeline)|
|
||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| [](https://deepwiki.com/ModelTC/llmc) | ||
| [](https://deepwiki.com/ModelTC/LightCompress) |
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.
Thank you for updating this link. Similar to my comment on README.md, this file also contains a Star History badge that should be updated. The link on line 216 still points to the old repository name.
Please update it to ModelTC/LightCompress for consistency.
Suggested change for line 216:
[](https://star-history.com/#ModelTC/LightCompress&Timeline)
No description provided.