docs: update README with examples and remove outdated sections - #482
Conversation
Sorry, something went wrong.
📝 Walkthrough
WalkthroughThe README.md was reworked: the project description was simplified, development setup and coding style sections were removed, documentation links now point to the online wiki, Vulkan/Visual Studio requirements were removed, and an Examples section was added. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem🚥 Pre-merge checks | ✅ 3 ✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches 🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. ❤️ ShareComment @coderabbitai help to get the list of available commands and usage tips. Tip CodeRabbit can use Clang for C/C++ static analysis and code quality checks.Clang provides comprehensive static analysis for C and C++ code, including syntax checking, type checking, and various warning diagnostics. |
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agentsVerify each finding against the current code and only fix it if needed. Inline comments: In `@README.md`: - Line 1: The README images lack alt text which breaks accessibility and linting; update each <img> tag (e.g., the one referencing "docs/images/Banner.png" and the other images around the example section) to include meaningful alt attributes (for example alt="Project banner" for the banner and descriptive alt text for the example images) so every <img> tag has an appropriate alt="" value. - Around line 10-11: Update the README wording: hyphenate "developer-friendly" in the first sentence and revise the second sentence to read naturally — replace "provide truly open-source project and be accessible to everyone" with something like "be a truly open-source project and be accessible to everyone" or "be a truly open-source project and accessible to everyone" so the article and parallel structure are correct; modify the lines containing "developer friendly" and "truly open-source project" accordingly. - Line 17: Replace the invalid HTML break tag "</br>" with a valid self-closing break tag (either "<br />" or "<br>") in the README image lines where the markup shows the image tag and trailing break; search for the literal string "</br>" and update those occurrences so the Markdown renders correctly (e.g., change "</br>" to "<br />").
ℹ️ Review info ⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a68a0af7-7ab7-4311-81bf-741d4de7c82d
📥 CommitsReviewing files that changed from the base of the PR and between d97b893 and ebc64b1.
📒 Files selected for processing (1)- README.md
Sorry, something went wrong.
There was a problem hiding this comment.
README.md (2)🤖 Prompt for all review comments with AI agents1-1: ⚠️ Potential issue | 🟡 Minor
Add alt text to the banner image (accessibility/lint).
Line 1 still uses an <img> without alt, which triggers MD045 and reduces accessibility.
Suggested fix🤖 Prompt for AI Agents-<img src="docs/images/Banner.png"> +<img src="docs/images/Banner.png" alt="Engine² banner">Verify each finding against the current code and only fix it if needed. In `@README.md` at line 1, The README uses an <img> tag referencing Banner.png without an alt attribute which triggers MD045; update the <img src="docs/images/Banner.png"> element to include a meaningful alt attribute (for example alt="Project banner" or a short descriptive phrase) so the tag becomes <img src="docs/images/Banner.png" alt="..."> to satisfy accessibility/lint rules.
11-11: ⚠️ Potential issue | 🟡 Minor
Fix grammar in project description sentence.
Line 11 reads unnaturally (“provide truly open-source project”). Suggested wording:
Suggested fix🤖 Prompt for AI Agents-It is designed to provide truly open-source project and be accessible to everyone. +It is designed to be a truly open-source project and be accessible to everyone.Verify each finding against the current code and only fix it if needed. In `@README.md` at line 11, Replace the awkward sentence "It is designed to provide truly open-source project and be accessible to everyone." with a grammatically correct version such as "It is designed to be a truly open-source project and to be accessible to everyone." Locate the exact sentence in README.md and update it accordingly.
Verify each finding against the current code and only fix it if needed. Duplicate comments: In `@README.md`: - Line 1: The README uses an <img> tag referencing Banner.png without an alt attribute which triggers MD045; update the <img src="docs/images/Banner.png"> element to include a meaningful alt attribute (for example alt="Project banner" or a short descriptive phrase) so the tag becomes <img src="docs/images/Banner.png" alt="..."> to satisfy accessibility/lint rules. - Line 11: Replace the awkward sentence "It is designed to provide truly open-source project and be accessible to everyone." with a grammatically correct version such as "It is designed to be a truly open-source project and to be accessible to everyone." Locate the exact sentence in README.md and update it accordingly.
ℹ️ Review info ⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 74225687-379a-4c1d-80f6-d93da566d36e
📥 CommitsReviewing files that changed from the base of the PR and between ebc64b1 and 5dea632.
📒 Files selected for processing (1)- README.md
Sorry, something went wrong.
|
Sorry, something went wrong.
Pull Request
Description
Update the README to be up to date
Related Issues
None
Type of Change
Please delete options that are not relevant.
Changes Made
Documentation
Checklist
Breaking Changes
None
Additional Notes
None
Summary by CodeRabbit