make a readme for the template itself
This commit is contained in:
19
README.md
19
README.md
@@ -1,13 +1,18 @@
|
|||||||
# Project name
|
# Aider project skeleton
|
||||||
|
|
||||||
A brief description of what this project does.
|
A personal template for starting new projects with Aider. Focused on disciplined AI assisted development. Loads SPEC, ARCH, CONVENTIONS and TESTS into AI context automatically so the model works against documented requirements instead of vibes.
|
||||||
|
|
||||||
## Setup
|
## What's in here
|
||||||
|
|
||||||
How does one run this project
|
- .aider.conf.yml - Aider config (models, auto-test..)
|
||||||
|
- .gitignore - Common stuff easy to forget.
|
||||||
|
- SPEC.md - What the project does
|
||||||
|
- ARCH.md - How it's built
|
||||||
|
- CONVENTIONS.md - Code style rules the AI follows
|
||||||
|
- TESTS.md - Test cases in natural language
|
||||||
|
- JOURNAL.md - Personal session notes
|
||||||
|
|
||||||
## Project structure
|
## Philosophy
|
||||||
|
|
||||||
Descriptions of files and structures.
|
LLMs work well as translation layers from clear specs to code. Badly as substitutes for engineering thinking. The discipline files exist to keep the human doing the part humans should do (deciding what gets built, what correctness looks like, what constraints matter) and the AI doing the part it's good at (translating that into syntax).
|
||||||
|
|
||||||
## Workflow
|
|
||||||
13
README.template.md
Normal file
13
README.template.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# Project name
|
||||||
|
|
||||||
|
A brief description of what this project does.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
How does one run this project
|
||||||
|
|
||||||
|
## Project structure
|
||||||
|
|
||||||
|
Descriptions of files and structures.
|
||||||
|
|
||||||
|
## Workflow
|
||||||
Reference in New Issue
Block a user