oil-oil/beautify-github-readme

README design skill for Claude Code & Codex. 帮你把 GitHub README 做得好看又好懂。

解决的问题

许多 GitHub 仓库拥有所有必要的信息,但呈现顺序不佳,导致访客在了解项目价值之前,就先看到安装指令等技术细节。本项目提供一套重新设计 README 的系统,确保项目价值、实际应用证明与使用路径能立即被理解。

运作方式

此工具作为一个 AI Agent 技能运作,分析仓库以识别其核心价值与证明。它将视觉层与内容层分开,以维持可搜索性与可维护性:

  • 内容层 (Content Layer):优化阅读顺序,消除重复内容,并将内部术语替换为具体成果。
  • 视觉层 (Visual Layer):使用 SVG 制作可编辑的标题图、区段过渡与图表。它能结合确定性的 SVG 版面配置与 AI 生成的去背影像,创造出具有有机纹理或角色的混合构图。
  • 工程层 (Engineering Layer):确保资源符合 GitHub 规范,影像具备无障碍性,且指令保持可复制性。

目标对象

希望在不将 README 变成冗长且无法搜索的图片的情况下,让项目价值主张变得清晰且专业的开发者与开源维护者。

特色亮点

  • 两种操作模式:提供“完整 README”模式进行文字与视觉的全面重设计,以及“仅资源”模式用于建立标题图或徽章等特定视觉元素。
  • 混合视觉效果:结合 SVG 的精确度与 AI 生成的点阵素材,实现电影级光影与复杂材质。
  • 层级优先方法:优先考虑项目价值与证明,而非内部术语与安装步骤。
  • 项目原生设计:从项目本身提取字体、颜色与构图,而非使用通用模板。

相关

  • 项目
  • 项目
  • 项目
  • 项目
  • 项目