From fdc19d8519de2067dfd6d558b798c6667c26d5c8 Mon Sep 17 00:00:00 2001 From: Joe Fleming Date: Mon, 9 Mar 2026 15:42:24 -0600 Subject: [PATCH] docs: add a readme with a quick descripion of using AGENTS.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..14a89d4 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Project AGENTS Template + +This is the AGENTS file I use to bootstrap new projects. It defines the workflow and conventions for working with LLMs on software engineering tasks. It only explains how I want it to keep track of the work, it is not prescriptive about any technologies, so it should be usable anywhere. + +## Workflow + +1. **Plan Mode** - Start by discussing what you want to build with the LLM +2. **Flesh Out** - Iterate on the idea, clarify requirements +3. **Generate** - Have the LLM generate `/docs` and `/memory-bank` based on the agreed plan + +## Key Files + +- **AGENTS.md** - This file. Contains the core workflow and conventions. +- **/docs/** - Permanent documentation layer (PRD, Architecture, API, Schema, Discoveries) +- **/memory-bank/** - Operational state for the AI agent (projectBrief, productContext, activeContext, systemPatterns, progress) +