Skip to content

Commit 8a1c8ef

Browse files
docs(ELI5): clarify Obsidian — optional but its own dedicated section
Promotes Obsidian from a one-line mention buried inside "Three things to know" to a proper "What about Obsidian?" section: short answer, what it is, decision matrix (3 user types → recommendation), 4-step install. Required-vs-optional now explicit at the top of "What do I need?" so beginners don't wonder whether they have to install it. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 64f0cc7 commit 8a1c8ef

1 file changed

Lines changed: 46 additions & 4 deletions

File tree

ELI5.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,14 @@ yours.**
2323

2424
## What do I need?
2525

26+
**Required:**
2627
- A computer (Windows, macOS, or Linux)
2728
- **Python 3.10 or newer** — type `python --version` in your terminal to check
2829
- **Claude Code** already installed and working — type `claude --version` to check
2930

31+
**Optional but most people install it (more on this below):**
32+
- **Obsidian** — a free app that makes the notebook prettier to browse
33+
3034
That's it. No account. No cloud. No bills.
3135

3236
---
@@ -107,10 +111,7 @@ in any text editor. It's just text. It's just yours.
107111

108112
If you don't like a note → delete the file. Gone.
109113

110-
If you want to make it nicer → install **Obsidian** (free) and point it
111-
at the folder. Now your notes are a connected note-taking system, with
112-
links and graph view and search. Mnemos doesn't require this; it's just
113-
a free upgrade if you want one.
114+
(For a much nicer way to browse them, see the Obsidian section below.)
114115

115116
### 3. There's no AI bill
116117

@@ -122,6 +123,47 @@ Your Anthropic dashboard will not show new charges from Mnemos. Ever.
122123

123124
---
124125

126+
## What about Obsidian?
127+
128+
**Short answer:** You don't need Obsidian. Mnemos works without it. But
129+
most people install it anyway because it makes the notebook a lot nicer
130+
to use, and it's free.
131+
132+
### What is Obsidian?
133+
134+
[Obsidian](https://obsidian.md) is a free desktop app. Point it at a
135+
folder of `.md` files and it shows them as a beautiful, connected
136+
note-taking system — with sidebar navigation, full-text search, a graph
137+
view of how your notes link to each other, and a clean reader.
138+
139+
It does **not** upload anything. It does **not** need an account. It is
140+
just a viewer/editor for the folder you already have.
141+
142+
### Do I need it?
143+
144+
| You're someone who... | Obsidian recommendation |
145+
|---|---|
146+
| Just wants Claude to remember you, doesn't care about reading the notes | **Skip it.** You're done. Mnemos works fine without it. |
147+
| Wants to occasionally read what got written | **Optional.** Any text editor (Notepad, VS Code, TextEdit) opens `.md` files. |
148+
| Wants to actually browse/search/explore your memory | **Get it.** This is the experience the project was built around. |
149+
150+
### How do I install Obsidian?
151+
152+
1. Go to [obsidian.md](https://obsidian.md) and download for your OS
153+
2. Open Obsidian
154+
3. Click **"Open folder as vault"**
155+
4. Pick the same folder you gave to `mnemos init`
156+
157+
Done. Your `Sessions/` notes now show up in Obsidian's sidebar. Click
158+
any wikilink (`[[like this]]`) inside a note to jump to the linked
159+
note. Try the **graph view** (left sidebar icon that looks like a
160+
constellation) — it draws every link between every Session as a map.
161+
162+
That's the "memory palace" the project name hints at. The palace is
163+
just your folder; Obsidian is the lights.
164+
165+
---
166+
125167
## Did something look weird?
126168

127169
| What you saw | What happened |

0 commit comments

Comments
 (0)