From 955918bce32cb6e6c4347ad5021c5dd14ef22b33 Mon Sep 17 00:00:00 2001 From: zichun Date: Tue, 28 Apr 2026 19:36:11 +0800 Subject: [PATCH] README: document venv + dependency install step --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+), 0 deletions(-) diff --git a/README.md b/README.md index 8d892b4..ba21eaf 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,19 @@ xly-wiki/ └── site/ 共享生成输出,已被 git 忽略 ``` +## 安装 + +依赖只需安装一次,全部装在仓库根目录的 `.venv/` 中(已被 git 忽略,请勿提交): + +```bash +python3 -m venv .venv +.venv/bin/pip install -r en/requirements.txt +``` + +`zh/requirements.txt` 与英文版相同;上面那条命令已经覆盖两种语言。 + +如果之后修改了 `requirements.txt`(例如新增依赖),重新执行同一条 `pip install` 即可更新。 + ## 构建 ```bash @@ -61,6 +74,19 @@ xly-wiki/ └── site/ shared generated output, ignored by git ``` +## Install + +Dependencies are installed once into a `.venv/` at the repo root (gitignored — do not commit it): + +```bash +python3 -m venv .venv +.venv/bin/pip install -r en/requirements.txt +``` + +`zh/requirements.txt` is identical to the English file, so the single command above covers both languages. + +If `requirements.txt` changes later (new dependency added), re-run the same `pip install` to refresh. + ## Build ```bash -- libgit2 0.22.2