mirror of
https://github.com/lllin000/PaperForge.git
synced 2026-07-22 06:50:53 +00:00
docs: replace git+https install URLs with pip install paperforge (PyPI)
This commit is contained in:
parent
e42c38e212
commit
fd82c28991
6 changed files with 13 additions and 13 deletions
|
|
@ -9,7 +9,7 @@
|
|||
```
|
||||
[ ] Zotero 已安装 + Better BibTeX 插件已启用
|
||||
[ ] Obsidian 已打开当前 Vault
|
||||
[ ] PaperForge 已安装 (pip install git+https://github.com/LLLin000/PaperForge.git)
|
||||
[ ] PaperForge 已安装 (pip install paperforge)
|
||||
[ ] PaddleOCR API Key 已配置(在 .env 中)
|
||||
[ ] 目录结构已创建(安装向导会自动完成)
|
||||
[ ] Zotero 数据目录已链接到 <system_dir>/Zotero
|
||||
|
|
@ -498,7 +498,7 @@ paperforge update
|
|||
|
||||
**pip 安装用户:**
|
||||
```bash
|
||||
pip install --upgrade git+https://github.com/LLLin000/PaperForge.git
|
||||
pip install --upgrade paperforge
|
||||
```
|
||||
|
||||
**pip editable / git clone 用户:**
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@
|
|||
## Method 2: CLI via pip (Developers)
|
||||
|
||||
```bash
|
||||
pip install git+https://github.com/LLLin000/PaperForge.git
|
||||
pip install paperforge
|
||||
```
|
||||
|
||||
Then run the headless setup:
|
||||
|
|
@ -31,7 +31,7 @@ python -m paperforge setup --headless --agent opencode --paddleocr-key <key>
|
|||
For the latest stable release, replace `master` with a version tag:
|
||||
|
||||
```bash
|
||||
pip install git+https://github.com/LLLin000/PaperForge.git@v1.4.17rc3
|
||||
pip install paperforge==1.5.2
|
||||
```
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -262,7 +262,7 @@ BRAT auto-detects plugin updates. For the Python package:
|
|||
```bash
|
||||
paperforge update
|
||||
# or
|
||||
pip install --upgrade git+https://github.com/LLLin000/PaperForge.git
|
||||
pip install --upgrade paperforge
|
||||
```
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -262,7 +262,7 @@ BRAT 会自动检测插件更新。Python 包更新:
|
|||
```bash
|
||||
paperforge update
|
||||
# 或
|
||||
pip install --upgrade git+https://github.com/LLLin000/PaperForge.git
|
||||
pip install --upgrade paperforge
|
||||
```
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -131,11 +131,11 @@ python --version
|
|||
### Step 2: 安装 paperforge 包
|
||||
|
||||
```bash
|
||||
pip install git+https://github.com/LLLin000/PaperForge.git
|
||||
pip install paperforge
|
||||
```
|
||||
|
||||
- 成功 → "paperforge 已安装",继续 Step 3
|
||||
- 权限错误 → 重试:`pip install --user git+https://github.com/LLLin000/PaperForge.git`
|
||||
- 权限错误 → 重试:`pip install --user paperforge`
|
||||
- 其他错误 → 把错误信息展示给用户,**停止**
|
||||
|
||||
---
|
||||
|
|
@ -275,7 +275,7 @@ python -m paperforge status
|
|||
|
||||
加 `--user`:
|
||||
```bash
|
||||
pip install --user git+https://github.com/LLLin000/PaperForge.git
|
||||
pip install --user paperforge
|
||||
```
|
||||
|
||||
### 用户已经装过 PaperForge(升级场景)
|
||||
|
|
|
|||
|
|
@ -131,11 +131,11 @@ python --version
|
|||
### Step 2: Install paperforge package
|
||||
|
||||
```bash
|
||||
pip install git+https://github.com/LLLin000/PaperForge.git
|
||||
pip install paperforge
|
||||
```
|
||||
|
||||
- Success → "paperforge installed." Proceed to Step 3.
|
||||
- Permission error → retry: `pip install --user git+https://github.com/LLLin000/PaperForge.git`
|
||||
- Permission error → retry: `pip install --user paperforge`
|
||||
- Other errors → show the error to user, **STOP**.
|
||||
|
||||
---
|
||||
|
|
@ -216,7 +216,7 @@ paperforge setup --headless --vault "D:\Documents\MyVault" --agent opencode --zo
|
|||
|
||||
| Exit code | Meaning | Action |
|
||||
|-----------|---------|--------|
|
||||
| 1 | Package root not found | Reinstall: `pip install --force-reinstall git+https://github.com/LLLin000/PaperForge.git` |
|
||||
| 1 | Package root not found | Reinstall: `pip install --force-reinstall paperforge` |
|
||||
| 4 | Worker scripts missing | Same as above |
|
||||
| 5 | Skill files missing | Same as above |
|
||||
| 6 | File integrity check failed | Check disk space and write permissions on vault path |
|
||||
|
|
@ -275,7 +275,7 @@ Wrap in quotes: `--vault "D:\My Documents\MyVault"`
|
|||
|
||||
Add `--user`:
|
||||
```bash
|
||||
pip install --user git+https://github.com/LLLin000/PaperForge.git
|
||||
pip install --user paperforge
|
||||
```
|
||||
|
||||
### User already has PaperForge (upgrade scenario)
|
||||
|
|
|
|||
Loading…
Reference in a new issue