mirror of https://github.com/lllin000/PaperForge.git synced 2026-07-22 06:50:53 +00:00

Research Assistant 29edb2d811 fix: overhaul install flow clarity and non-destructive incremental setup

- Move Better BibTeX auto-export to post-install step (exports dir created by setup)
- Clarify wizard overview: show resources_dir/literature_dir/control_dir hierarchy
- Fix post-install flow order: BBT export → enable plugin → dashboard → sync
- Split do_ocr and analyze marks into separate steps (OCR before deep-reading)
- Mark all literature flags via Base views, not manual file editing
- Make installer incremental: preserve existing files, only create missing ones
- Remove destructive junction/link deletion in TUI wizard
- Merge .env instead of overwriting; skip overwrite for AGENTS.md, docs, plugin
- Update TUI, headless, and plugin completion output to match corrected flow
- Add regression test for non-destructive setup behavior

2026-05-06 22:47:07 +08:00

1.7 KiB

Raw Blame History

PaperForge 快速安装指南

详细版教程（含截图和每个步骤的说明）请见 setup-guide.md。

前置条件

Python 3.10+
Zotero + Better BibTeX 插件
Obsidian
PaddleOCR API Key（申请地址）

安装向导是增量式的：如果你选择的 Vault 或目录里已经有文件，PaperForge 只会创建缺失的目录和文件，不会删除已有内容。

安装（推荐方式：pip）

# 1. 安装
pip install git+https://github.com/LLLin000/PaperForge.git

# 2. 运行安装向导（会把插件文件部署到当前 Vault）
paperforge setup

向导会引导你完成 Vault 配置、Zotero 链接、API Key 设置，并把插件文件部署到 .obsidian/plugins/paperforge/。

安装向导完成后，才进入 Obsidian 启用插件；启用之前不能打开 Dashboard。

Better BibTeX 配置

这一步在 paperforge setup 完成之后再做，因为导出目录要先由安装向导创建。

打开 Zotero
对你要同步的库或分类右键 → Export... / 导出...
格式选择 Better BibTeX JSON
勾选 "Keep updated"
导出到：{你的Vault}/[system_dir]/PaperForge/exports/
JSON 文件名会作为 Base 名称，例如：library.json、骨科.json

验证安装

paperforge status   # 确认 setup 已经把 PaperForge 部署到当前 Vault

然后在 Obsidian 中：

Settings -> Community Plugins -> Installed -> PaperForge -> Enable
按 Ctrl+P 搜索 PaperForge

之后再执行：

paperforge doctor   # 诊断所有组件

下一步

详细使用流程见 setup-guide.md。

1.7 KiB Raw Blame History Unescape Escape