Agent skill · writing content · aiskillstore
readme-generator-free
Generate polished README files from project code. Use when the user says "generate readme", "create README", "write project documentation", "make a readme", or asks for README generation, project documentation, installation docs, usage docs, API docs, badges, or repository onboarding documentation derived from an existing codebase.
Why this skill is useful
Adds specific commands and patterns for generating README files based on various project structures that the AI wouldn't reliably generate on its own.
What it needs
About 2k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
README Generator Create a polished, accurate README.md from the project files that actually exist. Prefer evidence from manifests, source files, comments, and command output over generic filler. Workflow 1. Inspect the project root before writing: Node: package.json Python: requirements.txt, pyproject.toml, setup.py, or setup.cfg Go: go.mod Rust: Cargo.toml Java: pom.xml, build.gradle, or build.gradle.kts Make commands: Makefile License: LICENSE, LICENSE.md, or package manifest license fields 2. Detect the main entry point: Node/TypeScript: package.json main, bin, exports, src/index.ts, src/index.js, index.js, or server.js Python: main.py, app.py, package console scripts, or main.py Go: main.go or cmd//main.go Rust: src/main.rs, src/lib.rs, or [[bin]] entries in Cargo.toml Java: Maven/Gradle application plugin config or src/main/java//Main.java 3. Extract dependencies only from actual manifests: Node: dependencies, devDependencies, peerDependencies, and optionalDependencies Python: requirements.txt, pyproject.toml, setup.py, or setup.cfg Go: require blocks in go.mod Rust: [dependencies], [dev-dependencies], and [build-dependencies] Java: Maven dependencies or Gradle dependencies 4. Extract scripts and commands: Node: package.json scripts Make: targets from Makefile Python: console scripts in package metadata, common commands from project files Go/Rust/Java: standard build, test, and run commands when the matching manifest exists 5. Infer description cautiously: Prefer package.json/manifest description fields. Otherwise use top-level comments, module docstrings, existing docs, or repository/folder name. If there is not enough evidence, write a modest one-sentence description and mark unknown specifics as TODO. 6. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/readme-generator-free