docs: add a readme with a quick descripion of using AGENTS.md

This commit is contained in:
Joe Fleming
2026-03-09 15:42:24 -06:00
parent a9695ba8f6
commit fdc19d8519

16
README.md Normal file
View File

@@ -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)