sirian/template-project
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add a quick start and a minimum starting point

Browse Source
This commit is contained in:
Elias Ahokas
2026-06-17 23:39:15 +03:00
parent 2aaa6441e9
commit 4bf8cbf57e
1 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -1,6 +1,27 @@
# Aider project skeleton
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.
A personal template for starting new projects with AI coding tools. 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.
## Quick start
```bash
git clone git@git.sirian.me:sirian/template-project.git my-project
cd my-project
rm -rf .git && git init && git add . && git commit -a -m "Initial commit from skeleton"
```
## Minimum starting point
Before writing any code fill these two things:
### 1. SPEC.md
What are you building and who is it for?
### 2. ARCH.md
Stack and commands. What technologies and what commands does the AI need to know?
## What's in here
@@ -8,7 +29,7 @@ A personal template for starting new projects with Aider. Focused on disciplined
- .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
- CONVENTIONS.md - Code style rules
- TESTS.md - Test cases in natural language
- JOURNAL.md - Personal session notes