Doc Create Readme Omega

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

majiayu000 2101822 2 files Β· 1.8 KB Updated 567 repo stars

File contents

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

# 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

majiayu000/claude-skill-registry-data/tree/main/documents/doc-create-readme-omega commit 210182297e

Frequently asked questions

npx skillmds add majiayu000/doc-create-readme-omega