Skip to content

docs(readme_en): 修复照做即失败的 Windows 命令与 .env 文件引用 - #117

Open
hailuohl wants to merge 1 commit into
jihe520:mainfrom
hailuohl:docs/fix-readme-en-windows-commands
Open

docs(readme_en): 修复照做即失败的 Windows 命令与 .env 文件引用#117
hailuohl wants to merge 1 commit into
jihe520:mainfrom
hailuohl:docs/fix-readme-en-windows-commands

Conversation

@hailuohl

@hailuohl hailuohl commented Sep 7, 2026

Copy link
Copy Markdown

Summary

README_EN.md 中有 4 处"照文档操作第一步就失败"的错误:

  1. Windows 命令分隔符错误(原第 189 行):

    set ENV=DEV ; uvicorn app.main:app --host 0.0.0.0 --port 8000 ...
    

    cmd 不把 ; 当命令分隔符——整串 DEV ; uvicorn ... 会被赋值给 ENV,uvicorn 根本不会执行。且该行丢失 --reload 参数(与 macOS/Linux 行不一致)。改为分两行命令并补齐参数。

  2. 虚拟环境路径与安装流程矛盾(原第 185 行):venv\Scripts\activate.bat,而同块上一行 macOS/Linux 用的是 source .venv/bin/activate——上方步骤 uv sync 生成的是 .venv,Windows 路径应为 .venv\Scripts\activate.bat

  3. 不存在的 backend/.env.dev.example(原第 132、158 行):仓库中实际文件为 backend/.env.examplecp backend/.env.dev.example ... 直接报 No such file。

  4. 不存在的 frontend/.env.example(原第 133、164 行):frontend 下的 frontend/.env.development 已在仓库中且被跟踪,无需(也无处)复制;改为"直接编辑该文件"。

验证

  • 逐条对照仓库实际文件:backend/.env.example 存在、frontend/.env.development 存在、frontend/.env.example 不存在、backend/.env.dev.example 不存在;
  • 修复后的命令在 Windows cmd 语义下可逐行执行(set ENV=DEV 单独一行)。

备注

中文版 README 对应步骤(.\venv\Scripts\Activate.ps1 + uv sync 并存)的矛盾由另一个 PR(win_start.bat 自动探测 venv/.venv + README 注释)处理,本 PR 只修 README_EN 明确的错误,改动保持最小。

@hailuohl hailuohl closed this Sep 7, 2026
@hailuohl
hailuohl force-pushed the docs/fix-readme-en-windows-commands branch from ca4a9dd to 83d8783 Compare September 7, 2026 19:35
@hailuohl hailuohl reopened this Sep 7, 2026
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.

1 participant