Skip to content

doc:增加 uv 使用指南#164

Merged
weinibuliu merged 2 commits intoMaaXYZ:mainfrom
amingnn:doc
Mar 2, 2026
Merged

doc:增加 uv 使用指南#164
weinibuliu merged 2 commits intoMaaXYZ:mainfrom
amingnn:doc

Conversation

@amingnn
Copy link
Copy Markdown
Contributor

@amingnn amingnn commented Mar 1, 2026

新增 uv 作为推荐安装方式。
解耦 uv 与 pip 的操作步骤,结构更清晰。
同步更新中英文档。

Summary by Sourcery

将基于 uv 的快速上手文档为推荐方式,用于安装和运行 MaaDebugger,并与传统的 pip 工作流并列展示。

Documentation:

  • 重构英文和中文 README 中的快速上手章节,突出说明使用 uv 作为全局或临时工具来安装和运行 MaaDebugger。
  • 记录与 uv 对应的并行 Python(pip)安装、运行和升级命令,作为 uv 的替代方案。
  • 通过在所有安装方式中统一 --port 的使用示例,来明确端口配置说明。
Original summary in English

Summary by Sourcery

Document uv-based quick start as the recommended way to install and run MaaDebugger, alongside the traditional pip workflow.

Documentation:

  • Restructure the quick start section in both English and Chinese READMEs to highlight uv as a global or temporary tool for installing and running MaaDebugger.
  • Document parallel Python (pip) installation, run, and upgrade commands as an alternative to uv.
  • Clarify port configuration by unifying --port usage examples across all installation methods.

新增 uv 作为推荐安装方式。
解耦 uv 与 pip 的操作步骤,结构更清晰。
同步更新中英文档。
Copy link
Copy Markdown

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

嘿,我在这里给出一些整体反馈:

  • 在新的端口部分中,不再提到 MaaDebugger 默认使用 8011 端口;建议保留一条关于默认端口行为的简要说明,以便为用户保留这部分背景信息。
  • 在更新说明中,pip 路径会明确升级 MaaDebugger 和 MaaFW,而 uv 路径只升级 MaaDebugger;如果 MaaFW 也需要显式升级,可能值得添加一个对应的 uv 示例,或者说明为什么不需要升级。
用于 AI Agent 的提示
Please address the comments from this code review:

## Overall Comments
- The new port section no longer mentions that MaaDebugger defaults to port 8011; consider keeping a brief note about the default port behavior to preserve that context for users.
- In the update instructions, the pip path explicitly upgrades both MaaDebugger and MaaFW, while the uv path only upgrades MaaDebugger; if MaaFW also needs explicit upgrading, it may be worth adding a corresponding uv example or clarifying why it is not needed.

Sourcery 对开源项目是免费的——如果你觉得我们的评审有帮助,欢迎分享 ✨
帮我变得更有用!请在每条评论上点 👍 或 👎,我会根据你的反馈来改进后续评审。
Original comment in English

Hey - I've left some high level feedback:

  • The new port section no longer mentions that MaaDebugger defaults to port 8011; consider keeping a brief note about the default port behavior to preserve that context for users.
  • In the update instructions, the pip path explicitly upgrades both MaaDebugger and MaaFW, while the uv path only upgrades MaaDebugger; if MaaFW also needs explicit upgrading, it may be worth adding a corresponding uv example or clarifying why it is not needed.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The new port section no longer mentions that MaaDebugger defaults to port 8011; consider keeping a brief note about the default port behavior to preserve that context for users.
- In the update instructions, the pip path explicitly upgrades both MaaDebugger and MaaFW, while the uv path only upgrades MaaDebugger; if MaaFW also needs explicit upgrading, it may be worth adding a corresponding uv example or clarifying why it is not needed.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

追加回不小心删掉的默认端口说明
@weinibuliu weinibuliu merged commit 9b8df13 into MaaXYZ:main Mar 2, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants