skills.rest
real-case
real-caseCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

readme

Generate or update README.md files based on actual codebase analysis.

Updated Apr 16, 2026
Search Tags:#documentation#markdown#onboarding#project setup#readme#codebase analysis#generate
One-click install
npx skills add https://github.com/real-case/marvin-toolkit --skill readme-real-case
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme
Source: https://github.com/real-case/marvin-toolkit/tree/main/plugins/marvin/skills/readme
Command: npx skills add https://github.com/real-case/marvin-toolkit --skill readme-real-case

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and maintaining accurate project READMEs is tedious, and outdated documentation misleads new team members. This Skill analyzes your actual codebase to generate or update a README.md that reflects reality, not guesswork. ## Core Features & Use Cases - Codebase-Driven Generation: Detects tech stack from config files like package.json, pyproject.toml, go.mod, and Cargo.toml, then reads CLAUDE.md, docs/, Makefile, and CI configs for setup context. - Structured Template: Produces a standard README layout covering quick start, prerequisites, installation, usage, project structure, development, and configuration, dropping sections that don't apply. - Safe Updates: When updating an existing README, it preserves custom sections, shows a diff, and asks for confirmation before writing. - Use Case: A new team member joins a project with no documentation. Run this Skill to produce an onboarding-ready README where every command and path is verified against the codebase. ## Quick Start Ask the assistant to generate a README for this project based on the current codebase.

Frequently Asked Questions about readme

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

FAQPage Schema
How do I generate a README from my codebase automatically?▼

Invoke the readme skill and it analyzes your config files, entry points, and docs to produce a structured README.md. Every command and path is verified against the codebase, so nothing is invented.

How to update an existing README without losing custom sections?▼

The skill reads your existing README first, preserves custom sections, and notes what is outdated. It shows a diff of proposed changes and asks for confirmation before writing anything.

What project types does README generation support?▼

It detects tech stacks from package.json, pyproject.toml, go.mod, Cargo.toml, and Dockerfile, covering Node.js, Python, Go, Rust, and containerized projects. It also reads Makefiles, docker-compose, and CI configs for build context.

Does the generated README include made-up commands or features?▼

No. The skill enforces a rule that every command and path must be verifiable from the codebase. It never invents features, and sections that don't apply to the project are dropped from the template.

When should I not use automated README generation?▼

Avoid it when your README requires marketing copy, product positioning, or narrative content not derivable from code. The skill produces factual technical documentation, so brand voice and promotional sections need manual writing.

Related Skills

Explore More Software Engineering Skills→
duthahoduthaho
8

map

Maps unfamiliar codebases into concise AGENTS-style orientation guides with file-backed claims.

Community
Advanced
mkalkeremkalkere
4

documentation

Generate and update READMEs, API docs, and guides from code.

Community
Advanced
lorehqlorehq

documentation-principles

Apply documentation principles to link content and prevent duplication.

Official
Basic
soo-kate-yeonsoo-kate-yeon

moai-docs-generation

Generate API documentation from source code and OpenAPI specifications.

Community
Advanced