skills.rest
afonsoft
afonsoftCOMMUNITY
Explore all skills by this author →
Website𝕏@afonsoftGitHub

create-readme

Generates README.md and CHANGELOG.md files from repository evidence and git history.

Updated Jul 21, 2026
Search Tags:#changelog#documentation#markdown#readme#semver#git history#keep a changelog
One-click install
npx skills add https://github.com/afonsoft/gamehub --skill create-readme-afonsoft
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-readme
Source: https://github.com/afonsoft/gamehub/tree/main/.claude/skills/create-readme
Command: npx skills add https://github.com/afonsoft/gamehub --skill create-readme-afonsoft

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Projects often ship with missing, outdated, or inaccurate README and CHANGELOG files, leaving contributors unable to understand what the project does, how to run it, or what changed between versions. ## Core Features & Use Cases - Evidence-Based README Generation: Analyzes package manifests, directory structure, CI workflows, and git history to produce README sections (badges, tech stack, architecture, getting started, tests) where every claim traces to a real file or commit. - Keep a Changelog Authoring: Builds CHANGELOG.md following Keep a Changelog and SemVer, populating the Unreleased section from git log since the last tag and mapping conventional commit prefixes to categories. - Bilingual Documentation Layout: Produces README.md in English plus a README.pt-br.md translation, with auxiliary docs organized under docs/en/ and docs/pt/. - Use Case: Before releasing version 2.0 of a .NET web platform, run this Skill to refresh the README with verified setup commands and generate a changelog of all commits since v1.9.0. ## Quick Start Ask the assistant to use the create-readme skill to generate a README and CHANGELOG for this repository based on its code and git history.

Frequently Asked Questions about create-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README.md for an existing project?▼

Run the create-readme skill against the repository root. It performs a discovery phase analyzing package manifests, directory structure, CI workflows, and git history, then generates README sections only where concrete evidence exists in the codebase.

How to create a CHANGELOG from git history?▼

The skill runs git log since the last tag and maps conventional commit prefixes like feat: and fix: to Keep a Changelog categories such as Added and Fixed. It also links versions to GitHub compare and release URLs.

Does the README generator support multiple languages?▼

Yes. It always generates README.md in English as the primary page plus a README.pt-br.md Portuguese translation, with auxiliary documents placed in docs/en/ and docs/pt/ folders and cross-language links at the top of each README.

When should I not use a README generator skill?▼

Avoid it for API reference docs (use OpenAPI, TypeDoc, or docfx), license files (copy license text directly), internal code documentation (use docstrings or XML comments), and architecture diagrams (use a dedicated diagram skill).

Why does the generated README skip some sections?▼

Sections are skipped when no supporting evidence exists in the repository. The skill never invents content, so a missing tests section means no test commands were found in package scripts or Makefiles.

Related Skills

Explore More Software Engineering Skills→
squidlleesquidllee

explain

Traces source code back to original session transcripts to explain its intent.

Community
Intermediate
Arete-ConsortiumArete-Consortium
4

release-engineering

Orchestrates preflight checks, changelog generation, version bumps, tagging, and publishing for software releases.

Official
Advanced
d-o-hubd-o-hub
4

drawio

Create draw.io architecture diagrams with inline mermaid previews and .drawio XML output.

Community
Intermediate
infiquetrainfiquetra
8

sdk-documentation

Generate SDK documentation with API references from code comments.

Official
Intermediate