# Doc Create Readme Omega

> {{ 𝛀𝛀𝛀 }} Generate a comprehensive README.md from project analysis

- Skill: `majiayu000/doc-create-readme-omega` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds add majiayu000/doc-create-readme-omega`
- Raw SKILL.md: https://api.skillmd.com/api/skills/majiayu000/doc-create-readme-omega/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: majiayu000 (https://skillmd.com/u/majiayu000)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/majiayu000/doc-create-readme-omega

---


Analyze project structure, code, and existing docs to generate an accurate README.md.

## Steps
1. Analyze project: name, purpose, tech stack, directory structure, build system, key features
2. Determine README sections: overview, features, prerequisites, installation, usage, configuration, structure, development, doc links
3. Generate README content:
    - Clear project description
    - Code blocks for commands
    - Table of contents if long
    - Link to docs/ for details
4. Show for approval; backup existing README if present

## Structure

```md
# 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