Agent skill
doc-create-readme-omega
{{ 𝛀𝛀𝛀 }} Generate a comprehensive README.md from project analysis
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/doc-create-readme-omega
SKILL.md
Analyze project structure, code, and existing docs to generate an accurate README.md.
Steps
- Analyze project: name, purpose, tech stack, directory structure, build system, key features
- Determine README sections: overview, features, prerequisites, installation, usage, configuration, structure, development, doc links
- Generate README content:
- Clear project description
- Code blocks for commands
- Table of contents if long
- Link to docs/ for details
- Show for approval; backup existing README if present
Structure
# Project Name
[One-line description]
## Overview / ## Features / ## Prerequisites / ## Installation / ## Usage
## Configuration / ## Project Structure / ## Development / ## Documentation / ## License
Notes
- Keep brief - README is overview, not full docs
- Focus on "getting started" info
- Include actual commands, not placeholders
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?