Readme Generator

为 GitHub 项目生成作品集级 README.md。适用于「帮我写 README」「生成 README」「优化 README」「README 最佳实践」「项目首页」「开源说明」「README 信息图」「README 封面」「用 Codex Image Gen / gpt-image-2 生成 README 图片」等请求。输出包括克制的 README 叙事、最多两张高质量视觉资产、压缩后的图片、MIT 许可证、GitHub Description 和 Topics 推荐、推荐星级，以及可选 gh CLI 更新建议。重点是帮项目讲清自己的故事，并基于项目类型判断视觉强度，避免套模板、堆信息和过度设计。

50 stars 1 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)

npx skills add geekjourneyx/readme-generator --skill readme-generator

Manual install

git clone --depth 1 https://github.com/geekjourneyx/readme-generator.git /tmp/readme-generator
mkdir -p ~/.claude/skills
cp -r /tmp/readme-generator/. ~/.claude/skills/readme-generator

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# GitHub README Generator

README 是项目的第一张作品集页面。它不是说明书的目录，也不是功能清单的容器。它要在很短时间内回答三件事：

1. 这是什么。
2. 为什么值得看。
3. 我怎么开始使用。

本 Skill 的目标是生成 **100 分 README 作品**：清楚、有审美、克制、可信，能让项目像一个完整作品一样被理解。

---

## 第一性原理

README 是信任入口和路径入口，不是完整文档。它应该帮助第一次打开仓库的人做出快速判断：

1. 这个项目解决什么问题。
2. 它适不适合我。
3. 我是否能马上运行、安装或继续了解。

1w star 以上开源项目通常不是靠信息量取胜，而是靠清晰的首屏、直接的上手路径、可信的文档入口和克制的社区信息取胜。图片、徽章、作者信息和设计理念都只是辅助；一旦它们拖慢理解，就是噪音。

本 Skill 的核心取舍：README 先讲清项目，再做美化；视觉服务理解，不替代理解。

---

## 作品标准

用下面的评分表约束所有输出：

| 维度 | 分值 | 判断标准 |
|------|------|----------|
| 15 秒理解 | 25 | 首屏能看懂项目名、价值、适用对象 |
| 项目故事 | 20 | 不是堆功能，而是讲清背景、动机和结果 |
| 视觉表达 | 20 | 图片像作品，不像小字流程截图 |
| 快速开始 | 15 | 安装和使用路径短、明确、可复制 |
| 可信产物 | 10 | 展示真实输出、能力边界或结果 |
| 克制降噪 | 10 | 去掉重复、口号、过度解释和装饰 |

低于 90 分的 README 不交付；先删噪音、放大重点、重排叙事。

### 高星项目基线

默认向高星开源项目学习这些结构：

- 项目名 + 一句话价值主张。
- 少量必要 badge，不堆状态装饰。
- 快速开始或文档入口靠前。
- 示例只在能降低上手成本时出现。
- 贡献、社区、安全、许可证简洁清楚。
- UI / 产品项目可放截图；库、SDK、基础设施项目少图或无图。

不要把 README 写成设计宣言、完整说明书、功能墙、社交名片或内部工作流报告。

---

## 设计原则

### 必须坚持

- H1 必须是项目正式名称，紧跟一句价值主张。
- README 开头先讲项目价值，再放安装细节。
- 图片只表达一个重点，但应该承担项目名片功能：让读者一眼看到项目名和定位。
- 默认最多两张图片：一张封面，一张核心能力或结果图。
- GitHub 会缩小图片显示，图片里的主文案必须按海报字号设计。
- 对功能的描述要具体，但不夸张；能用结果说明就不要自夸。
- 对作者和许可证保持简洁，不做社交名片堆砌。

### 必须避免

- ASCII 艺术标题。
- emoji 装饰标题或作者表格。
- 大段“我们很专业”的空话。
- 6 个以上小卡片堆在一张图里。
- 流程图里塞满阶段、命令和小字说明。
- 把第三张流程图当作默认产物；工作方式通常用正文讲更清楚。
- 把 Image Gen 当作长文排版工具。
- 把 README 写成完整产品手册；详细文档应放到 `docs/`。

---

## 总体流程

Read the full skill on GitHub

Details

Skill name: readme-generator
Repository: geekjourneyx/readme-generator
License: MIT
Repo updated: 3 June 2026

FAQ

What does the Readme Generator skill do?

How do I install the Readme Generator skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add geekjourneyx/readme-generator --skill readme-generator. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Readme Generator popular?

It lives in geekjourneyx/readme-generator, which has 50 GitHub stars and 1 forks.

Related skills

Openclaw Docs Sync

TheSethRose/OpenClaw-Docs-Sync

Sync OpenClaw + ClawHub + Skills docs into a local mirror for the QMD memory backend.

Writing & Content

Lazy Cat

albertobarnabo/lazy-cat

Keeps code changes as small as the problem allows. Use before writing or changing code, including small fixes, single functions and quick scripts, and especially before generating data, fixtures or seed records, or hand-writing something a stdlib call, package, public API or open dataset already provides (validation, parsing, auth, dates, currency, geo). Checks for that cheaper path first, then writes only what was asked: no unrequested error handling, tests, docstrings, flags, abstractions or refactors. Not for infra/terraform/k8s or database queries.

Writing & Content

Write Iut Thesis

sakhadib/IUT-Thesis-Skill-for-AI

Draft, expand, revise, structure, and maintain a full Islamic University of Technology BSc thesis from source documents using the local iutbscthesis LaTeX template. Use when writing or editing thesis metadata, front matter, abstract, chapters, related works, methodology, results, discussion, conclusion, citations, appendices, figures, tables, code listings, or compile guidance for main.tex. Also use when the user expects an AI agent to turn papers, notes, PDFs, LaTeX sources, bib files, data tables, and assets into a substantial thesis manuscript chapter by chapter without requiring repeated b

Writing & Content

SEO Content Writer

Yaroslavle/seo-content-writer-claude-skill

Full AI-assisted workflow for long-form SEO content (2,000+ words). Covers JTBD strategy, E-E-A-T quality standards, and 5 production phases: research, outline, draft, editing, and SEO/publishing. Built for B2B marketing agency context. Use when: user wants to write or optimize an SEO article, mentions "SEO content", "blog post", "GTM article", "long-form content", or asks to create content with keyword strategy.

Writing & Content

Dergipark

saidsurucu/dergipark-skill

Use when the user wants to search Turkish academic journals on DergiPark (keyword or advanced field search by title/author/abstract/DOI/ORCID/year/etc.), read a DergiPark article PDF as text, or extract an article's references — drives the user's own Chrome (no CAPTCHA solving needed) by injecting JavaScript.

Writing & Content

Nsfc Nssfc Grant Writing

ganlin770/nsfc-nssfc-grant-writing

帮助申请人撰写自己的【国家社会科学基金（国社科/NSSFC）】与【国家自然科学基金（国自然/NSFC）】项目申请书/标书/本子的完整辅导 skill。覆盖选题与申请代码归口、立项依据与研究现状述评、研究内容/研究目标/关键科学问题凝练、研究方案与技术路线、创新点、研究基础与队伍、经费预算、预期成果、年度计划、活页匿名、评审打分逻辑与被毙原因、科研诚信红线与生成式AI使用规范、申报流程时间线，并内置【图表制作】工具一键生成技术路线图/研究框架图/机制模型图/甘特图（matplotlib，导出可印刷的 PNG/PDF/SVG）。 Use this whenever the user mentions 国社科/国家社会科学基金/社科基金/国自然/国家自然科学基金/自科基金/基金申请书/标书/本子/ 活页/课题论证/立项依据/技术路线图/申报书/面上项目/青年基金/重大项目/重点项目/中华学术外译/后期资助，或说"写基金/改本子/ 润色立项依据/做技术路线图/凝练科学问题/基金申报/课题申报/申请书怎么写/评审会不会中"。这是写"自己的"申请书的辅助工具，不代写、不买卖申请书。NOT for 期刊论文写作/毕业论文/开题报告（用 thesis 相关 skill）、纯文献综述、或与基金申报无关的写作。

Writing & Content

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.