39 lines
906 B
Markdown
39 lines
906 B
Markdown
# README Instructions
|
|
|
|
> For writing style, diagrams and workflow: see [documentation.instructions.md](../skills/documentation.instructions.md)
|
|
|
|
## Purpose
|
|
|
|
README is the entry point for both humans and AI.
|
|
Start with the **problem the project solves** — one or two sentences.
|
|
|
|
---
|
|
|
|
## Required Sections
|
|
|
|
1. **What is this?** — the problem and solution in plain language
|
|
2. **How to run locally** — minimal commands only, no theory
|
|
3. **Key links** — links to `docs/` files, nothing else
|
|
|
|
---
|
|
|
|
## Rules
|
|
|
|
- Keep under ~100 lines — if more is needed, it belongs in `docs/`
|
|
- No duplication of docs content — link instead
|
|
- Written in English
|
|
|
|
---
|
|
|
|
## If README Is Missing
|
|
|
|
Ask the user:
|
|
1. What problem does this project solve?
|
|
2. How is it started locally?
|
|
|
|
Do not invent content.
|
|
|
|
## If README Is Outdated
|
|
|
|
Point out specifically what is wrong. Fix only that — do not rewrite the whole file.
|