← All skills

readme-generator

80 / 100 · Low risk

Fine to try.

By ArabelaTso/Skills-4-SE (GitHub) · coding · 260 stars · scanned at commit 4f38503

Generate comprehensive, user-friendly README.md files for code repositories. Use when creating documentation for new projects, updating existing READMEs, or improving project onboarding. Produces READMEs with project introduction, prerequisites, environment setup, executable usage instructions, and repository structure overview. Supports application projects, libraries, and research codebases.

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-generator' ] || [ -L ~/.agents/skills/'readme-generator' ]; then echo 'A skill folder named readme-generator already exists — not replacing it' >&2; false; else d=$(mktemp -d) && git clone --quiet --filter=blob:none --no-checkout 'https://github.com/ArabelaTso/Skills-4-SE' "$d" && git -C "$d" checkout --quiet '4f38503747e0617504bce5329283ef837d375c09' -- 'skills/readme-generator' && mkdir -p ~/.agents/skills && cp -R "$d"/'skills/readme-generator' ~/.agents/skills/'readme-generator' && 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-generator' ~/.claude/skills/'readme-generator' (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 ArabelaTso/Skills-4-SE shows the score of its lowest-scoring skill.

[![SkillTrust](https://zalavijaysinh.github.io/skilltrust/badges/ArabelaTso/Skills-4-SE.svg)](https://zalavijaysinh.github.io/skilltrust/repos/ArabelaTso/Skills-4-SE/)

Score history