Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

myreadnote

个人阅读笔记:Markdown vault 真源 + 本地 Python 服务 + 桌面 App(Tauri:macOS / Windows)。

设计文档入口:docs/README.md(建议先读 docs/OVERVIEW.md)。

架构摘要

  • 共享 API 客户端:packages/app-client@myreadnote/client
  • 桌面壳:apps/desktop(macOS / Windows 同壳)
  • 最终产物:release/desktop:stage 写入;二进制默认不入库)
  • apps/web:仅浏览器调试,不是产品主路径

环境

conda activate py312
cd /path/to/myreadnote
pip install -e ".[dev]"
# macOS 默认 vault:~/Documents/ReadyNote
myreadnote init
# 或:myreadnote init --vault ~/Documents/ReadyNote

另需:Rust(rustup)、Node.js;macOS 需 Xcode CLT;Windows 需 MSVC + WebView2。
LLM / API Key 只写本机 ~/.config/myreadnote/config.toml,勿提交。

启动

myreadnote ui              # 按平台启动桌面(缺后端时 App 可拉起 serve)
myreadnote ui --dev        # 强制 Tauri 开发模式
# 或:cd apps/desktop && npm run desktop:dev

打包(在目标平台本机;不交叉编译):

cd apps/desktop
npm run desktop:build
npm run desktop:stage      # → release/windows/ 或 release/macos/

CLI 速查

myreadnote add "10.1145/example" --title "Example"
myreadnote add "Attention Is All You Need"          # 自动按标题搜索入库
myreadnote add "LLM …" --by-title                   # 强制标题搜索
myreadnote add "ambiguous/text" --as-id             # 强制标识符
myreadnote list
myreadnote stats
myreadnote research <entry_id>
myreadnote worker --once
myreadnote serve

文档

文档 说明
docs/OVERVIEW.md 产品定位与已拍板决策
docs/ARCHITECTURE_CLIENTS.md 客户端架构
docs/DESKTOP_UX.md 桌面布局与文案
docs/UI_STYLE.md 按钮/控件设计风格(必遵)
docs/AUTO_PIPELINE.md 研究管线(现行)
docs/VAULT_TREE_PLAN.md Vault 目录树
docs/METADATA.md 远程元数据

About

Personal Markdown reading notes vault with FastAPI + Tauri desktop

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages