Skip to main content
command CX Codex

create-readme-section — Claude Code command: generate README sections

The create-readme-section command for Claude Code generates README sections based on project files. Create installation instructions, API references, or contribution guides.

MIT ★ 2,744 updated 2026-10-08

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/commands/create-readme-section.md
Open on GitHub

What create-readme-section does

This command tells Claude to produce a specific README section on demand. Describe what you need—setup instructions, API reference, contributing guide, troubleshooting—and Claude examines your project files (package.json, requirements.txt, etc.) to understand context, then writes a section that fits your README's existing style.

Each section type follows proven patterns. Installation sections include prerequisites, step-by-step procedures, and verification checks. Usage sections have code examples with expected output. API reference includes endpoint descriptions, request and response formats, error codes. The output arrives with correct Markdown formatting, code blocks with language tags, and appropriately structured lists.

The command lives at .claude/commands/create-readme-section.md in Claude Code. Other platforms have their own paths: Codex uses ~/.codex/prompts/create-readme-section.md, GitHub Copilot uses .github/prompts/create-readme-section.prompt.md, and Gemini CLI uses .gemini/commands/create-readme-section.toml.

What it helps with

  • write an installation section with prerequisites and verification steps
  • generate an API reference documenting endpoints and error responses
  • create a contributing guide that matches your README style
  • draft a configuration section listing environment variables
  • produce a troubleshooting section with solutions to common issues

Example prompts for the agent

  • Generate an installation section for my Python project
  • Write an API reference section with request and response examples
  • Create a contributing guide that matches our README formatting

How to install create-readme-section

Manually: put the files in place

.claude/commands/create-readme-section.md

Call it with /create-readme-section. For all projects use ~/.claude/commands/

Questions about create-readme-section

How do I install create-readme-section in Claude Code?

Add a file .claude/commands/create-readme-section.md at your project root with the command definition. After that, Claude Code will let you call it from the commands menu or search.

What does create-readme-section do?

It generates a structured README section based on your request—installation, API docs, contributor guidelines, and more. Claude reads your project context and outputs text that follows best practices.

Is create-readme-section available on platforms other than Claude Code?

Yes. For Codex, use ~/.codex/prompts/create-readme-section.md. For GitHub Copilot, use .github/prompts/create-readme-section.prompt.md. For Gemini CLI, use .gemini/commands/create-readme-section.toml. Each platform has its own installation path.

Source text

create-readme-section.md · MIT
# Create README Section

Generate a specific section for a README file based on the user's request. This command helps create well-structured, professional README sections that follow best practices.

## Usage Examples

### Basic Usage
"Create an installation section for my Python project"
"Generate a contributing guide section"
"Write an API reference section for my REST endpoints"

### Specific Sections
- **Installation**: Step-by-step setup instructions
- **Usage**: How to use the project with examples
- **API Reference**: Detailed API documentation
- **Contributing**: Guidelines for contributors
- **License**: License information
- **Configuration**: Configuration options and environment variables
- **Troubleshooting**: Common issues and solutions
- **Dependencies**: Required dependencies and versions
- **Architecture**: High-level architecture overview
- **Testing**: How to run tests
- **Deployment**: Deployment instructions
- **Changelog**: Version history and changes

## Instructions for Claude

When creating a README section:

1. **Analyze the Project Context**: Look at existing files (package.json, requirements.txt, etc.) to understand the project
2. **Follow Markdown Best Practices**: Use proper headings, code blocks, and formatting
3. **Include Practical Examples**: Add code snippets and command examples where relevant
4. **Be Comprehensive but Concise**: Cover all important points without being verbose
5. **Match Existing Style**: If a README already exists, match its tone and formatting style

### Section Templates

#### Installation Section
- Prerequisites
- Step-by-step installation
- Verification steps
- Common installation issues

#### Usage Section
- Basic usage examples
- Advanced usage scenarios
- Command-line options (if applicable)
- Code examples with expected output

#### API Reference Section
- Endpoint descriptions
- Request/response formats
- Authentication details
- Error codes and handling
- Rate limiting information

#### Contributing Section
- Development setup
- Code style guidelines
- Pull request process
- Issue reporting guidelines
- Code of conduct reference

### Output Format

Generate the section with:
- Appropriate heading level (usually ## or ###)
- Clear, structured content
- Code blocks with language specification
- Links to relevant resources
- Bullet points or numbered lists where appropriate

Remember to ask for clarification if the section type or project details are unclear.

© centminmod · MIT · centminmod/my-claude-code-setup

Similar slash commands

All slash commands for Writing and docs →

From the same set35

The whole set →
04_stack_trace_debug The 04_stack_trace_debug prompt asks Claude Code to find the cause of a Python stack trace, identify the failing call, and suggest a fix. Use it when you need a compact diagnosis. GP ChatGPT ★ 2,744repo stars 07_json_reshape 07_json_reshape — a prompt that rebuilds a JSON sample against a fixed rubric and returns nothing but parseable JSON. GP ChatGPT ★ 2,744repo stars 03_code_review 03_code_review — a prompt for reviewing Python diffs. It forces Claude to return exactly three concrete issues as a bulleted list without conversational filler. GP ChatGPT ★ 2,744repo stars ccusage-daily This command runs ccusage daily -b and turns Claude Code usage figures into a Markdown report. Use it to review costs, token totals, and daily spending. CX Codex +1 ★ 2,744repo stars 01_claudemd_summarise 01_claudemd_summarise — a Claude Code prompt that compresses CLAUDE.md documentation into exactly 120 words in a single paragraph, without headings or lists. Use it to standardize project architecture summaries for AI coding context. GP ChatGPT ★ 2,744repo stars security-audit The security-audit command scans a codebase for vulnerabilities and unsafe patterns across a project or a specific module. CX Codex +1 ★ 2,744repo stars check-best-practices The check-best-practices command reviews code against language-specific standards, conventions, and best practices. It spots issues from critical bugs to style violations and suggests concrete improvements. CX Codex +1 ★ 2,744repo stars claude-docs-consultant claude-docs-consultant pulls official Claude Code documentation directly from code.claude.com on demand. Fetches only the markdown files needed for the active task. CX Codex +1 ★ 2,744repo stars

Project sponsors

Companies that keep this analytics open