Skip to content

docs: edit readme instructions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gearsandcode wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: edit readme instructions #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
133f1b3
docs: fix clone instructions in readme
Copilot May 12, 2026
9b4aa39
Clarify memory guidance in docs
Copilot May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ You wake up fresh each session. These files are your continuity:

### Daily Notes — `memory/YYYY-MM-DD.md`
- Create a new file each day (format: `memory/2026-05-03.md`)
- Log what you worked on, decisions made, things to follow up on
- Log the user's real work over time: what they worked on, decisions made, things to follow up on
- Keep it structured — not a transcript, but a useful summary
- Don't treat maintenance edits to this shared-brain repo itself as the kind of "work" that grows memory

### Long-Term Memory — `MEMORY.md`
- Your curated understanding of the world
Expand All @@ -35,7 +36,7 @@ You wake up fresh each session. These files are your continuity:
If you want to remember something, write it to a file. Mental notes don't survive session restarts. Files do.

- When you learn something important → update `MEMORY.md`
- When work happens → update today's daily note
- When the user does meaningful work over time → update today's daily note
- When you make a mistake → document it so future-you doesn't repeat it

**Text > Brain** 📝
Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ Open a terminal and navigate to your agent's workspace, then clone:
cd ~/.openclaw/workspace
git clone https://github.com/Jason-Cyr/ai-shared-brain.git .

# Example for Claude Code — make a new project folder, then launch Claude in it:
mkdir ~/ai-shared-brain
# Example for Claude Code — clone the repo, then launch Claude in it:
cd ~
git clone https://github.com/Jason-Cyr/ai-shared-brain.git
cd ~/ai-shared-brain
git clone https://github.com/Jason-Cyr/ai-shared-brain.git .
claude
```

Expand All @@ -75,9 +75,9 @@ Use the templates in this repo as a starting point.
1. **Edit `USER.md`** — Fill in your name, timezone, role, and preferences
2. **Edit `SOUL.md`** — Shape the agent's personality (or keep the default — it's a good start)
3. **Review `AGENTS.md`** — This is the operating manual. The startup ritual at the top is what makes everything work.
4. **Leave `MEMORY.md` alone** — It starts mostly empty. The agent fills it over time.
4. **Leave `MEMORY.md` alone** — It starts mostly empty. The agent fills it over time as you actually work together.
5. **Start a session** with your agent. It should read the files and begin building context.
6. **Give it a few days.** The memory folder and MEMORY.md will fill up on their own.
6. **Give it a few days.** The memory folder and MEMORY.md will fill up as you and the agent do real work together over time.

## File Structure

Expand All @@ -104,7 +104,7 @@ ai-shared-brain/
**MEMORY.md** — Starts empty. The agent fills it over time with curated knowledge: key decisions, project context, your preferences, lessons learned. Think of it as the agent's distilled understanding of your world. The agent periodically reviews daily notes and promotes important things here.

### Layer 3: Episodic Memory
**memory/YYYY-MM-DD.md** — Daily notes. The agent creates one each day and logs what happened: what you worked on, decisions made, things to follow up on. These are the raw material that feeds long-term memory.
**memory/YYYY-MM-DD.md** — Daily notes. The agent creates one for days when real work happens and logs what happened: what you worked on, decisions made, things to follow up on. These are the raw material that feeds long-term memory.

### Layer 4: Active Context (bring your own)
Connect your own knowledge base — Obsidian vault, Notion workspace, project folders, whatever you use. The agent reads from it to get real-time context on your work. This layer is yours to configure based on your setup.
Expand Down