30 lines
352 B
Markdown
30 lines
352 B
Markdown
|
Create a root README.md that explains the repo.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
# Project Name
|
||
|
|
|
||
|
|
## Purpose
|
||
|
|
What the system does.
|
||
|
|
|
||
|
|
## Architecture Overview
|
||
|
|
High level explanation.
|
||
|
|
|
||
|
|
## Repository Structure
|
||
|
|
|
||
|
|
repo/
|
||
|
|
docs/
|
||
|
|
src/
|
||
|
|
data/
|
||
|
|
tests/
|
||
|
|
ops/
|
||
|
|
|
||
|
|
## Development Workflow
|
||
|
|
|
||
|
|
1. Edit docs
|
||
|
|
2. Generate code
|
||
|
|
3. Run tests
|
||
|
|
4. Deploy
|
||
|
|
|
||
|
|
This becomes the entry point for AI tools.
|