Run any Skill in Manus with one click

Get Started

create-readme

Stars10

Forks5

UpdatedJune 21, 2026 at 03:37

Create or substantially refactor a repository README

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Run Skill in Manus

Source

z-shell

z-shell/.github

View GitHub Repository View Creator Repositories

Download

Run Skill in Manus

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

SKILL.md

readonly

name	create-readme
description	Create or substantially refactor a repository README

Create README

Create an accurate, concise, and visually intentional repository landing page.

Required workflow

Read the repository's source, tests, workflows, local instructions, release model, and linked organization policy before drafting.
Classify the repository. For a Zsh plugin, use templates/readme/zsh-plugin.md as the canonical structure.
Verify every feature, setting, default, alias, lifecycle claim, command, and branch statement against the current implementation.
Lead Zsh-plugin installation guidance with Zi. Keep other manager examples concise and include only intentionally supported or verified paths.
Keep long-form ecosystem guidance in the wiki and link to it.
Preserve meaningful visual identity: a clear header, a restrained maintained badge set, accessible alt text, and an optional behavior-focused screenshot or demo.
Do not add competitor comparisons unless comparison is the document's explicit purpose.
Run repository-appropriate Markdown, link, syntax, and behavior checks before claiming completion.

Visual guidance

Use GitHub Flavored Markdown and minimal HTML where it materially improves the header or image sizing.
Do not use decorative link clusters, excessive badges, emoji-heavy headings, or images without useful alt text.
Prefer repository-owned assets.
Screenshot and terminal-demo automation is tracked in Linear ZSH-18; until it lands, manually maintained visuals must be reviewed when documented output changes.

Scope

For focused README corrections, change only the affected content. Apply the full template when creating a repository or when the requested work is a substantial README refactor.

More from this repository

same repository

new-zsh-plugin

z-shell/.github

Scaffold a new Z-Shell-Standard-compliant Zsh plugin. Use when the user asks to create a new Zsh plugin, start a plugin from scratch, or add a plugin skeleton. Generates a compliant entry file (modeline, ZERO handling, Plugins hash, fpath guard, unload function) plus functions/ and docs/ layout.

2026-06-2110

zunit-test

z-shell/.github

Write and run ZUnit tests for Zsh plugins in this workspace. Use when the user asks to add tests for a plugin, write a .zunit test, or run the ZUnit suite. Covers ZUnit test syntax, the run/assert helpers, and the native test runner.

2026-06-2110

editorconfig

z-shell/.github

Generates a comprehensive and best-practice-oriented .editorconfig file based on project analysis and user preferences.

2026-05-2010

github-issues

z-shell/.github

Create, update, and manage GitHub issues using MCP tools. Use this skill when users want to create bug reports, feature requests, or task issues, update existing issues, add labels/assignees/milestones, set issue fields (dates, priority, custom fields), set issue types, manage issue workflows, link issues, add dependencies, or track blocked-by/blocking relationships. Triggers on requests like "create an issue", "file a bug", "request a feature", "update issue X", "set the priority", "set the start date", "link issues", "add dependency", "blocked by", "blocking", or any GitHub issue management task.

2026-05-2010

make-repo-contribution

z-shell/.github

All changes to code must follow the guidance documented in the repository. Before any issue is filed, branch is made, commits generated, or pull request (or PR) created, a search must be done to ensure the right steps are followed. Whenever asked to create an issue, commit messages, to push code, or create a PR, use this skill so everything is done correctly.

2026-05-2010

name	create-readme
description	Create or substantially refactor a repository README

Create README

Create an accurate, concise, and visually intentional repository landing page.

Required workflow

Read the repository's source, tests, workflows, local instructions, release model, and linked organization policy before drafting.
Classify the repository. For a Zsh plugin, use templates/readme/zsh-plugin.md as the canonical structure.
Verify every feature, setting, default, alias, lifecycle claim, command, and branch statement against the current implementation.
Lead Zsh-plugin installation guidance with Zi. Keep other manager examples concise and include only intentionally supported or verified paths.
Keep long-form ecosystem guidance in the wiki and link to it.
Preserve meaningful visual identity: a clear header, a restrained maintained badge set, accessible alt text, and an optional behavior-focused screenshot or demo.
Do not add competitor comparisons unless comparison is the document's explicit purpose.
Run repository-appropriate Markdown, link, syntax, and behavior checks before claiming completion.

Visual guidance

Use GitHub Flavored Markdown and minimal HTML where it materially improves the header or image sizing.
Do not use decorative link clusters, excessive badges, emoji-heavy headings, or images without useful alt text.
Prefer repository-owned assets.
Screenshot and terminal-demo automation is tracked in Linear ZSH-18; until it lands, manually maintained visuals must be reviewed when documented output changes.

Scope

For focused README corrections, change only the affected content. Apply the full template when creating a repository or when the requested work is a substantial README refactor.