docs: refine README install flow and devtool section#656
Conversation
Summary of ChangesHello @luoliwoshang, 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 enhancing the clarity and organization of the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request improves the clarity of the installation instructions in the README by separating the main tool installation from the optional development tools. The new structure is much easier to follow. I have one minor suggestion to improve consistency in the section headings.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
Clean separation of the required install from the optional dev tools. Two minor issues: the |
![fennoai[bot]](https://avatars.githubusercontent.com/in/1924301?s=60&v=4){kind=small}
| ``` | ||
|
|
||
| For normal package generation, only the `llcppg` binary is required. | ||
| The standalone tools above are kept mainly for debugging and isolated troubleshooting. | ||
|
|
||
|
|
There was a problem hiding this comment.
Nit: there's a double blank line here before ## Usage. One blank line is sufficient.
| ``` | |
| For normal package generation, only the `llcppg` binary is required. | |
| The standalone tools above are kept mainly for debugging and isolated troubleshooting. |
|
|
||
| For normal package generation, only the `llcppg` binary is required. | ||
|
|
||
| ### Development tools |
There was a problem hiding this comment.
Heading capitalization is inconsistent with the rest of the README (e.g., ### Generated Bindings, ### Development Tools). Also, there's already a ### Development Tools section later in the file (line 459). Consider capitalizing this and making the name more distinct, e.g.:
| ### Development tools | |
| ### Dev Tools (Optional) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #656 +/- ##
=======================================
Coverage 83.32% 83.32%
=======================================
Files 28 28
Lines 2501 2501
=======================================
Hits 2084 2084
Misses 369 369
Partials 48 48 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2 participants
Summary
mainbranch behaviorllgo install ./cmd/llcppgdevtoolsubsection under How to install:llgo install ./_xtool/llcppsymgllgo install ./_xtool/llcppsigfetchllgo install ./cmd/gogensiggo install ./cmd/llcppcfgScope
Documentation-only update. No code behavior changes.