first commit

2026-07-20 14:40:17 +08:00
commit 50fd043a2d
55 changed files with 7786 additions and 0 deletions
@@ -0,0 +1,41 @@
+# ChatPapers
+
+面向 **Zotero 9** 的 AI 论文阅读与总结插件：在 Zotero 内对 PDF 文献对话、摘要，并把结果保存为笔记。
+
+## 功能（MVP）
+
+- PDF / 条目侧栏 **ChatPapers** 对话面板
+- 一键总结、添加选区、流式回复、停止生成
+- 保存为 Zotero 子笔记
+- Provider 预设：**Ollama / LM Studio / OpenRouter / OpenAI / DeepSeek / 硅基流动 / 自定义**
+
+## 文档
+
+| 文档 | 说明 |
+| --- | --- |
+| [需求文档](docs/requirements.md) | 产品范围与验收 |
+| [开发文档](docs/development.md) | 技术架构与开发说明 |
+
+## 开发
+
+```bash
+npm install
+npm run build    # 产出 .scaffold/build/*.xpi
+npm run start    # 需本机已安装 Zotero 9，并配置 .env（见 .env.example）
+```
+
+## 安装
+
+1. `npm run build`
+2. 打开 Zotero → 工具 → 插件 → 从文件安装
+3. 选择 `.scaffold/build/chatpapers.xpi`（文件名以构建产物为准）
+
+## 使用
+
+1. 偏好设置 → ChatPapers：选择 Provider（如 Ollama）并填写模型
+2. 打开 PDF 或选中条目，在条目面板侧栏进入 **ChatPapers**
+3. 提问 / 总结 → 可将回复「保存为笔记」
+
+## 许可
+
+AGPL-3.0-or-later（基于 [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template)）