Просмотр исходного кода

docs: 添加仓库根目录 README

kekeZack 1 неделя назад
Родитель
Сommit
22f3c9dbe6
1 измененных файлов с 25 добавлено и 0 удалено
  1. 25 0
      README.md

+ 25 - 0
README.md

@@ -0,0 +1,25 @@
+# Obsidian Knowledge Base
+
+个人 LLM Wiki — 基于 Obsidian 的结构化 Markdown 知识库。
+
+## 目录结构
+
+```
+├── AGENTS.md               # 协作约定(快速参考)
+├── X-Knowledge-Base/        # Obsidian Vault(知识库内容)
+│   ├── raw/                 # 原始资料(只读)
+│   ├── wiki/                # 整理后知识层
+│   ├── CLAUDE.md            # 详细工作流参考
+│   └── COMMIT_GUIDELINES.md # 提交规范
+└── README.md
+```
+
+## 快速开始
+
+1. 用 Obsidian 打开 `X-Knowledge-Base/` 作为 Vault
+2. 查询入口:`wiki/index.md`
+3. 工作流约定:`AGENTS.md` / `CLAUDE.md`
+
+## Git 提交
+
+格式:`<类型>: <摘要>`,类型见 `COMMIT_GUIDELINES.md`。