diff --git a/README.md b/README.md index 4e90245..eb73f3c 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,15 @@ My AI learning system from this video: [How I Use AI to Learn Things](https://www.youtube.com/watch?v=kzcI5F4tGiU). -This is a personal system I built for myself, shared as-is. Built as a pi configuration: the teaching philosophy encoded in a skill, a few small extensions, and subagent briefs. +This is a personal system I built for myself, shared as-is. Originally built as a pi configuration; this fork is an omo configuration: the teaching philosophy encoded in a skill, a few small extensions, and subagent briefs. ## What's in it - `skills/teach/` — the philosophy and the process; `researcher.md` is the brief for the researcher subagent - `skills/visualize/` — adds a correct, minimal diagram to a lesson when an idea is clearer as a picture; `mermaid-maker.md` and `svg-maker.md` are the briefs for the maker subagents -- `extensions/ask-user-question/` — the agent asks you questions through a UI popup -- `extensions/quiz/` — graded questions with instant feedback (✓/✗, correct answer, explanation) -- `extensions/md-log/` — link a markdown file to the session +- `extensions/ask-user-question.ts` — the agent asks you questions through a UI popup +- `extensions/quiz.ts` — graded questions with instant feedback (✓/✗, correct answer, explanation) +- `extensions/md-log.ts` — link a markdown file to the session (`/md-log `, `/md-unlog`) ## Install @@ -28,13 +28,11 @@ Then open omo in that directory and trust the project when asked (project skills ## Requirements -- [omo](https://github.com/code-yeongyu/oh-my-openagent). Subagents run through its built-in `task` tool, which spawns a worker that reads the brief file and follows it. +- [omo](https://omo.dev). Subagents run through its built-in `task` tool, which spawns a worker that reads the brief file and follows it. - The visual makers must run on a model that can see images; the skill dispatches them with `category="unspecified-high"`. Point that category at a vision-capable model in `omo.jsonc`. - Rendering: `npx` (for `@mermaid-js/mermaid-cli`, which uses a puppeteer-managed Chrome) and `rsvg-convert` (or `nix shell nixpkgs#librsvg`, or ImageMagick as a fallback). - `ask-user-question` — use the copy bundled here. If your setup already has an `ask-user-question` extension, use **this** one in its place. Popups from different extensions serialize through a shared UI lock, which only works when it's the same implementation. ## Notes -You can run the system without subagents. The main session does the teaching. You just lose the researcher (truth verification) and the generated visuals. - The teaching skill is written for one learner (me). Edit the skill to fit how you learn best.