OpenSkillIndexโ† back to search
claude-code

Goblin-mode doc-create-readme-omega

{{ ๐›€๐›€๐›€ }} Generate a comprehensive README.md from project analysis

install
source ยท Clone the upstream repo
git clone https://github.com/JasonWarrenUK/goblin-mode
Claude Code ยท Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/JasonWarrenUK/goblin-mode "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/doc-create-readme-omega" ~/.claude/skills/jasonwarrenuk-goblin-mode-doc-create-readme-omega && rm -rf "$T"
manifest: skills/doc-create-readme-omega/SKILL.md
source content

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