docs: update README

[2bndy5]

follow-up to #306

Python is no longer required to be installed on the runner anymore.
uv sync will automatically download the latest supported stable version of Python.

This just removes a note about this in the README.

it also disables a few markdown lint rules that are violated (raw HTML used and first line is not the h1 title).

Summary by CodeRabbit

• Documentation
  • Updated README formatting by disabling specific markdownlint rules (MD033, MD041).
  • Removed outdated Usage section, including notes about Python 3.10 in the Docker image and container usage guidance.
  • Removed reference to an external discussion and the instruction to create a GitHub Actions workflow.
  • Clarified that no code or public API changes are included.

[shenxianpeng]

🚀

[coderabbitai]

Walkthrough

Adds markdownlint disables (MD033, MD041) at README top and removes deprecated usage notes (Python 3.10 in Docker, container guidance, link to #185) and a line about creating a GitHub Actions workflow. No code or API changes.

Changes

Cohort / File(s)	Summary of Changes
Documentation cleanup README.md	Added markdownlint-disable for MD033, MD041; removed obsolete Usage section content (Docker/Python 3.10 note, container usage, #185 reference) and the instruction to create .github/workflows/cpp-linter.yml. No code/API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• docs: update README.md to remove useless section #269 — Similar README cleanup removing unnecessary documentation content.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch revise-readme

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (3)

README.md (3)

84-84: Fix invalid HTML break tags

The HTML break tag is self-closing and should be
(or
).
is invalid and may render inconsistently.

-  </br>
+  <br>

Also applies to: 97-97

---

36-40: Clarify platform support to avoid contradiction

“Only support Linux (Debian-based)” and “MacOS and Windows runners are supported as well” are contradictory as written. Consider rephrasing for clarity, e.g.:

• Primary support: Debian-based Linux (Ubuntu, etc.). macOS and Windows runners are supported on a best-effort basis.

If that’s not accurate, clarify the exact scope of support.

---

157-157: Grammar: add an article

Minor wording improvement.

-## Have question or feedback?
+## Have a question or feedback?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ac82521 and ae56ab7.

📒 Files selected for processing (1)

• README.md (1 hunks)