Repository navigation
docs: 更新 README 以明确环境要求与构建说明 - #865
Conversation
kazukokawagawa
commented
Feb 11, 2026
kazukokawagawa
commented
- 明确 Node.js 和 pnpm 的版本要求
- 新增开发快速开始章节，包含依赖安装与构建命令
- 说明原生模块构建的 Rust 要求及跳过方式
- 更新本地部署步骤，简化命令并整合环境变量说明
- 补充 Docker 镜像的端口信息
- 明确 Node.js 和 pnpm 的版本要求 - 新增开发快速开始章节，包含依赖安装与构建命令 - 说明原生模块构建的 Rust 要求及跳过方式 - 更新本地部署步骤，简化命令并整合环境变量说明 - 补充 Docker 镜像的端口信息
Summary of ChangesHello @kazukokawagawa, 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! 此拉取请求旨在通过更新 README.md 文件，显著提升项目的开发和部署体验。它通过提供更清晰的环境要求、详细的开发快速开始指南以及简化的本地部署流程，帮助新用户和现有开发者更顺畅地设置和运行项目。此外，还增加了关于原生模块构建和 Docker 镜像端口的说明，使文档更加全面和易于理解。 Highlights
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}
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
该 PR 更新了项目 README，以更清晰地说明开发/部署所需的环境版本、构建命令，以及原生模块（Rust）相关要求与跳过方式，降低新贡献者上手与部署成本。
Changes:
- 明确 Node.js（>=20）与 pnpm（>=10）版本要求，并补充原生模块构建（Rust）与
SKIP_NATIVE_BUILD=true跳过方式说明 - 新增“开发 / 快速开始”章节，提供依赖安装、环境变量与构建命令
- 补充 Docker 镜像端口访问说明，并简化本地/服务器部署步骤中的包管理器命令
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # 或 | ||
| npm install pnpm -g |
There was a problem hiding this comment.
这里写了 pnpm 版本要求（>= 10）但安装示例只执行了 corepack enable，在没有 packageManager 版本锁定（当前 package.json 也未声明）时，corepack 实际启用/下载的 pnpm 版本不一定满足 >=10。建议在文档中补充 corepack prepare pnpm@10 --activate（或在仓库声明 packageManager: pnpm@...）以避免读者装到不兼容版本。
| # 或 | |
| npm install pnpm -g | |
| corepack prepare pnpm@10 --activate | |
| # 或（全局安装指定版本） | |
| npm install pnpm@^10 -g |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
