← All skills

readme

85 / 100 · Low risk

Fine to try.

By tamarillo-ai/theta (GitHub) · writing · 15 stars · scanned at commit 08c084f

When the user wants to create or update a README.md file for a project. Also use when the user says "write readme," "create readme," "document this project," "project documentation," or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architecture, and deployment.

Works with any agent that supports SKILL.md skills.

What this skill can do

Install

Paste this into your terminal. It downloads exactly the version we scanned, not whatever is newest.

if [ -e ~/.agents/skills/'readme' ] || [ -L ~/.agents/skills/'readme' ]; then echo 'A skill folder named readme already exists — not replacing it' >&2; false; else d=$(mktemp -d) && git clone --quiet --filter=blob:none --no-checkout 'https://github.com/tamarillo-ai/theta' "$d" && git -C "$d" checkout --quiet '08c084f718b2b842cd53622ce0b1a1fb2888ccef' -- 'test/cast-fixtures/codex-cli/regression/5chan/.codex/skills/readme' && mkdir -p ~/.agents/skills && cp -R "$d"/'test/cast-fixtures/codex-cli/regression/5chan/.codex/skills/readme' ~/.agents/skills/'readme' && rm -rf "$d"; fi

Codex reads ~/.agents/skills directly. For Claude Code, Cursor, Copilot, Gemini CLI, Antigravity or OpenCode, also link it. For Claude Code: ln -s ~/.agents/skills/'readme' ~/.claude/skills/'readme' (other agents: ~/.cursor/skills, ~/.copilot/skills, ~/.gemini/skills, ~/.gemini/config/skills, ~/.config/opencode/skills). Or install through the finder skill, which does both.

Badge for your README

The badge for tamarillo-ai/theta shows the score of its lowest-scoring skill.

[![SkillTrust](https://zalavijaysinh.github.io/skilltrust/badges/tamarillo-ai/theta.svg)](https://zalavijaysinh.github.io/skilltrust/repos/tamarillo-ai/theta/)

Score history

Also found in

Identical copies of this skill exist at:

• tamarillo-ai/theta/test/cast-fixtures/codex-cli/regression/seedit/.codex/skills/readme