Description: first line of existing README or ask user
Repository: git remote URL
License: LICENSE file content
For detailed package file format examples, see REFERENCE.md.
Step 2: Analyze current README state
Check existing README.md for these sections:
Logo/icon present (centered image at top)
Project title (h1)
Description/tagline
Badges row (license, version, CI status, coverage)
Features section
Tech Stack section
Prerequisites section
Installation instructions
Usage examples
Project structure
Contributing guidelines
License section
Discover logo/icon assets in common locations:
assets/logo.png, assets/icon.png, assets/logo.svg
public/logo.png, public/icon.svg
images/logo.png, docs/assets/logo.png
.github/logo.png, .github/images/logo.png
Step 3: Generate compliance report
Print a section-by-section compliance report showing PASS/MISSING/PARTIAL status for each README section. Include content quality checks (code examples, command correctness, link validity).
If --check-only is set, stop here.
For the compliance report format, see REFERENCE.md.
Step 4: Apply configuration (if --fix or user confirms)
Generate README.md following the standard template structure:
Centered logo section (if assets exist and --no-logo not set)
Project title and tagline
Badge row with shields.io URLs
Features section with key highlights
Tech Stack table
Getting Started (prerequisites, installation, usage)
Project Structure
Development commands
Contributing section
License section
For the full README template and badge URL patterns, see REFERENCE.md.
Step 5: Handle logo and assets
If no logo exists but user wants one:
Check for existing assets in standard locations
Suggest creating a simple text-based placeholder or using emoji heading
Create assets directory if needed: mkdir -p assets
Suggest tools: Shields.io for custom badges, Simple Icons for technology icons
Step 6: Detect project commands
Auto-detect project commands based on package manager/build tool:
Package Manager
Install
Run
Test
Build
npm/bun (package.json)
Read scripts from package.json
npm run dev
npm test
npm run build
uv/poetry (pyproject.toml)
uv sync / poetry install
uv run python -m pkg
uv run pytest
-
cargo (Cargo.toml)
cargo build
cargo run
cargo test
cargo build --release
go (go.mod)
go build
go run .
go test ./...
go build
Step 7: Generate project structure
Run tree -L 2 -I 'node_modules|target|__pycache__|.git|dist|build' --dirsfirst to generate accurate project structure. Skip common generated directories (node_modules, vendor, target, dist, build, pycache, .pytest_cache, .git, .venv, venv).
Print a summary of changes made, the README location, and recommended next steps (customize feature descriptions, add logo, run other configure commands).
When --style detailed is specified, also include architecture section with mermaid diagram, API reference link, and changelog link. For detailed style templates, see REFERENCE.md.
Output
Provide:
Compliance report with section-by-section status
Generated or updated README.md content
List of detected project metadata
Suggestions for improvement (logo, more features, etc.)
Agentic Optimizations
Context
Command
Quick compliance check
/configure:readme --check-only
Auto-fix all issues
/configure:readme --fix
Minimal README
/configure:readme --fix --style minimal
Full detailed README
/configure:readme --fix --style detailed
Generate project tree
tree -L 2 -I 'node_modules|target|__pycache__|.git|dist|build' --dirsfirst
Check README exists
test -f README.md && echo "EXISTS" || echo "MISSING"
