Skip to content

A self-organizing Obsidian vault that gives AI coding agents persistent memory.

docs(readme): mkdir + cd before shardmind install (#74)

Brenno Ferrari0f55ae71f380
diff --git a/README.ja.md b/README.ja.md
index 63b04ab..042cd2d 100644
--- a/README.ja.md
+++ b/README.ja.md
@@ -102,10 +102,11 @@ Decision: defer Redis migration. Win: Sarah praised the auth architecture.
```bash
npm install -g shardmind
+mkdir my-vault && cd my-vault
shardmind install github:breferrari/obsidian-mind
```
-ウィザードがあなたの名前、組織、ボールトの目的、含めるエージェント、QMDを有効化するかどうかを収集します。post-installフックがあなたの回答に基づいて`brain/North Star.md`をパーソナライズします。その後:
+`shardmind install` はカレントディレクトリに書き込むため、先に新しいフォルダを作成して移動してください。ウィザードがあなたの名前、組織、ボールトの目的、含めるエージェント、QMDを有効化するかどうかを収集します。post-installフックがあなたの回答に基づいて`brain/North Star.md`をパーソナライズします。その後:
1. インストールされたフォルダを**Obsidianボールト**として開く
2. 設定 → 一般で**Obsidian CLI**を有効化(Obsidian 1.12以上が必要)
diff --git a/README.ko.md b/README.ko.md
index 653797d..1e6096b 100644
--- a/README.ko.md
+++ b/README.ko.md
@@ -102,10 +102,11 @@ You: "wrap up"
```bash
npm install -g shardmind
+mkdir my-vault && cd my-vault
shardmind install github:breferrari/obsidian-mind
```
-마법사가 이름, 조직, 볼트 목적, 포함할 에이전트, QMD 활성화 여부를 수집합니다. post-install 훅이 답변에 따라 `brain/North Star.md`를 개인화합니다. 그런 다음:
+`shardmind install`은 현재 디렉토리에 기록하므로, 먼저 새 폴더를 만들고 그 안으로 이동하세요. 마법사가 이름, 조직, 볼트 목적, 포함할 에이전트, QMD 활성화 여부를 수집합니다. post-install 훅이 답변에 따라 `brain/North Star.md`를 개인화합니다. 그런 다음:
1. 설치된 폴더를 **Obsidian 볼트**로 엽니다
2. 설정 → 일반에서 **Obsidian CLI**를 활성화합니다 (Obsidian 1.12+ 필요)
diff --git a/README.md b/README.md
index f1ac8ef..c86b311 100644
--- a/README.md
+++ b/README.md
@@ -101,10 +101,11 @@ You: "wrap up"
```bash
npm install -g shardmind
+mkdir my-vault && cd my-vault
shardmind install github:breferrari/obsidian-mind
```
-The wizard collects your name, organization, vault purpose, agents to include, and whether to enable QMD; the post-install hook personalizes `brain/North Star.md` with your answers. Then:
+`shardmind install` writes into the current directory, so create and enter a fresh folder first. The wizard collects your name, organization, vault purpose, agents to include, and whether to enable QMD; the post-install hook personalizes `brain/North Star.md` with your answers. Then:
1. Open the installed folder as an **Obsidian vault**
2. Enable the **Obsidian CLI** in Settings → General (requires Obsidian 1.12+)
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 2eef292..047405a 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -102,10 +102,11 @@ Decision: defer Redis migration. Win: Sarah praised the auth architecture.
```bash
npm install -g shardmind
+mkdir my-vault && cd my-vault
shardmind install github:breferrari/obsidian-mind
```
-向导会收集你的姓名、组织、仓库用途、要包含的 Agent,以及是否启用 QMD。post-install 钩子会根据你的答案个性化 `brain/North Star.md`。然后:
+`shardmind install` 会写入当前目录,因此请先创建并进入一个新文件夹。向导会收集你的姓名、组织、仓库用途、要包含的 Agent,以及是否启用 QMD。post-install 钩子会根据你的答案个性化 `brain/North Star.md`。然后:
1. 将已安装的文件夹作为 **Obsidian 仓库** 打开
2. 在 设置 → 通用 中启用 **Obsidian CLI**(需要 Obsidian 1.12+)