·readme-generator
</>

readme-generator

dmccreary/claude-skills

此技能在当前项目的 GitHub 主目录创建或更新 README.md 文件。生成的 README.md 将符合 GitHub 最佳实践,包括徽章、项目概述、站点指标、入门说明和全面的文档。

38安装·1热度·@dmccreary

安装

$npx skills add https://github.com/dmccreary/claude-skills --skill readme-generator

SKILL.md

Generate or update a comprehensive README.md file for GitHub repositories following best practices.

This skill automates the creation of professional, well-structured README.md files for GitHub repositories. It generates all essential sections including badges for technologies used, project overview, site metrics, getting started instructions, project structure, and contact information. The skill is particularly optimized for MkDocs-based intelligent textbook projects but can be adapted for any repository type.

Before generating the README, gather information about the repository:

此技能在当前项目的 GitHub 主目录创建或更新 README.md 文件。生成的 README.md 将符合 GitHub 最佳实践,包括徽章、项目概述、站点指标、入门说明和全面的文档。 来源:dmccreary/claude-skills。

查看原文

可引用信息

为搜索与 AI 引用准备的稳定字段与命令。

安装命令
npx skills add https://github.com/dmccreary/claude-skills --skill readme-generator
分类
</>开发工具
认证
收录时间
2026-02-01
更新时间
2026-02-18

快速解答

什么是 readme-generator?

此技能在当前项目的 GitHub 主目录创建或更新 README.md 文件。生成的 README.md 将符合 GitHub 最佳实践,包括徽章、项目概述、站点指标、入门说明和全面的文档。 来源:dmccreary/claude-skills。

如何安装 readme-generator?

打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/dmccreary/claude-skills --skill readme-generator 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code 或 Cursor 中使用

这个 Skill 的源码在哪?

https://github.com/dmccreary/claude-skills