17 lines
551 B
Plaintext
17 lines
551 B
Plaintext
---
|
|
description: Keep README.md up to date when making relevant changes
|
|
alwaysApply: true
|
|
---
|
|
|
|
# README Maintenance
|
|
|
|
When changing the project, update `README.md` in the repo root if affected:
|
|
|
|
- **New features** → Add to "Quick Start" or "Configuration" section
|
|
- **Changed paths** (config, build) → Update table/text
|
|
- **New dependencies** → Update prerequisites
|
|
- **Platform changes** → Update table or reference to PLATFORM.md
|
|
- **Project structure** → Adjust directory tree
|
|
|
|
The README should remain clear and up to date for new users.
|