# Personal Project README Template

> Use this template for side projects, portfolio pieces, and experiments. Balance between documenting for future-you and showcasing for others.

- Skill: `tools-only/personal-project-readme-template` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add tools-only/personal-project-readme-template`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tools-only/personal-project-readme-template/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tools-only (https://skillmd.com/u/tools-only)
- Updated: 2026-09-29
- Page: https://skillmd.com/skills/tools-only/personal-project-readme-template

---

# Personal Project README Template

Use this template for side projects, portfolio pieces, and experiments.
Balance between documenting for future-you and showcasing for others.

---

# [Project Name]

[One-line description]

[Screenshot or demo GIF if visual]

## What This Does

[2-3 sentences explaining what it does and why you built it. Be specific about the problem it solves for you.]

## Demo

[Link to live demo, video, or screenshots]

## Tech Stack

- **[Category]**: [Technology] - [brief why you chose it]
- **[Category]**: [Technology]

## Getting Started

```bash
[Clone and run commands]
```

## How It Works

[Brief explanation of the interesting parts - architecture, algorithms, or techniques worth noting. This is useful for portfolio viewers and future-you.]

## What I Learned

[Key takeaways from building this. Good for portfolios and personal reference.]

- [Learning 1]
- [Learning 2]

## Future Ideas

- [ ] [Thing you might add]
- [ ] [Improvement you're considering]

## License

[License if you want one, or just "Personal project" if not sharing]